query_vars

Filters the query variables whitelist before processing.

Description

apply_filters( 'query_vars', (array) $wp_public_query_vars ); 

Allows adjusting of the default query vars that are made public.

Parameters (1)

0. $wp_public_query_vars (array)
Array of allowed WP_Query query vars.

Usage

To run the hook, copy the example below.
  1. $wp_public_query_vars = apply_filters( 'query_vars', $wp_public_query_vars ); 
  2.  
  3. if ( !empty( $wp_public_query_vars ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the query_vars callback 
  2. function filter_query_vars( $wp_public_query_vars ) { 
  3. // make filter magic happen here... 
  4. return $wp_public_query_vars
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'query_vars', 'filter_query_vars', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'query_vars', 'filter_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( 'query_vars', $wp->public_query_vars );