woocommerce_rest_<taxonomy>_query

Filter the query arguments, before passing them to `get_terms()`.

Description

apply_filters( 'woocommerce_rest_<taxonomy>_query', (array) $prepared_args, (WP_REST_Request) $request ); 

Enables adding extra arguments or setting defaults for a terms collection request.

Parameters (2)

0. $prepared_args (array)
Array of arguments to be passed to get_terms.
1. $request (WP_REST_Request)
The current request.

Usage

To run the hook, copy the example below.
  1. $prepared_args = apply_filters( 'woocommerce_rest_{$taxonomy}_query', $prepared_args, $request ); 
  2.  
  3. if ( !empty( $prepared_args ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_rest_<taxonomy>_query callback 
  2. function filter_woocommerce_rest_taxonomy_query( $prepared_args, $request ) { 
  3. // make filter magic happen here... 
  4. return $prepared_args
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "woocommerce_rest_{$taxonomy}_query", 'filter_woocommerce_rest_taxonomy_query', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "woocommerce_rest_{$taxonomy}_query", 'filter_woocommerce_rest_taxonomy_query', 10, 2 ); 

Defined (1)

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

/includes/abstracts/abstract-wc-rest-terms-controller.php  
  1. $prepared_args = apply_filters( "woocommerce_rest_{$taxonomy}_query", $prepared_args, $request );