woocommerce_api_default_response_handler

The WooCommerce woocommerce api default response handler hook.

Description

apply_filters( 'woocommerce_api_default_response_handler', (string) $wc_api_json_handler, (unknown) $this_path, (unknown) $instance ); 

Parameters (3)

0. $wc_api_json_handler (string) => 'WC_API_JSON_Handler'
The wc api json handler.
1. $this_path (unknown)
The this path.
2. $instance (unknown)
The instance.

Usage

To run the hook, copy the example below.
  1. $wc_api_json_handler = apply_filters( 'woocommerce_api_default_response_handler', $wc_api_json_handler, $this_path, $instance ); 
  2.  
  3. if ( !empty( $wc_api_json_handler ) ) { 
  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_default_response_handler callback 
  2. function filter_woocommerce_api_default_response_handler( $wc_api_json_handler, $this_path, $instance ) { 
  3. // make filter magic happen here... 
  4. return $wc_api_json_handler
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_api_default_response_handler', 'filter_woocommerce_api_default_response_handler', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_api_default_response_handler', 'filter_woocommerce_api_default_response_handler', 10, 3 ); 

Defined (3)

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

/includes/api/legacy/v3/class-wc-api-server.php  
  1. $handler_class = apply_filters( 'woocommerce_api_default_response_handler', 'WC_API_JSON_Handler', $this->path, $this ); 
/includes/api/legacy/v2/class-wc-api-server.php  
  1. $handler_class = apply_filters( 'woocommerce_api_default_response_handler', 'WC_API_JSON_Handler', $this->path, $this ); 
/includes/api/legacy/v1/class-wc-api-server.php  
  1. $handler_class = apply_filters( 'woocommerce_api_default_response_handler', 'WC_API_JSON_Handler', $this->path, $this );