woocommerce_rest_query_vars

Filter allowed query vars for the REST API.

Description

apply_filters( 'woocommerce_rest_query_vars', (array) $valid_vars ); 

This filter allows you to add or remove query vars from the final allowed list for all requests, including unauthenticated ones. To alter the vars for editors only.

Parameters (1)

0. $valid_vars (array)

Usage

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

Defined (1)

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

/includes/abstracts/abstract-wc-rest-posts-controller.php  
  1. $valid_vars = apply_filters( 'woocommerce_rest_query_vars', $valid_vars );