woocommerce_api_order_refunds_response

The WooCommerce woocommerce api order refunds response hook.

Description

apply_filters( 'woocommerce_api_order_refunds_response', (unknown) $order_refunds, (unknown) $order_id, (unknown) $fields, (unknown) $refund_items, (unknown) $instance ); 

Parameters (5)

0. $order_refunds (unknown)
The order refunds.
1. $order_id (unknown)
The order id.
2. $fields (unknown)
The fields.
3. $refund_items (unknown)
The refund items.
4. $instance (unknown)
The instance.

Usage

To run the hook, copy the example below.
  1. $order_refunds = apply_filters( 'woocommerce_api_order_refunds_response', $order_refunds, $order_id, $fields, $refund_items, $instance ); 
  2.  
  3. if ( !empty( $order_refunds ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_api_order_refunds_response callback 
  2. function filter_woocommerce_api_order_refunds_response( $order_refunds, $order_id, $fields, $refund_items, $instance ) { 
  3. // make filter magic happen here... 
  4. return $order_refunds
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_api_order_refunds_response', 'filter_woocommerce_api_order_refunds_response', 10, 5 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_api_order_refunds_response', 'filter_woocommerce_api_order_refunds_response', 10, 5 ); 

Defined (2)

The filter is defined in the following location(s).

/includes/api/legacy/v3/class-wc-api-orders.php  
  1. return array( 'order_refunds' => apply_filters( 'woocommerce_api_order_refunds_response', $order_refunds, $order_id, $fields, $refund_items, $this ) ); 
/includes/api/legacy/v2/class-wc-api-orders.php  
  1. return array( 'order_refunds' => apply_filters( 'woocommerce_api_order_refunds_response', $order_refunds, $order_id, $fields, $refund_items, $this ) );