query_vars

Filters the query variables whitelist before processing.

Description

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

Allows (publicly allowed) query vars to be added, removed, or changed prior to executing the query. Needed to allow custom rewrite rules using your own arguments to work, or any other custom query variables you want to be publicly available.

Parameters (1)

0. $this_public_query_vars (array)
The array of whitelisted query variables.

Usage

To run the hook, copy the example below.
  1. $this_public_query_vars = apply_filters( 'query_vars', $this_public_query_vars ); 
  2.  
  3. if ( !empty( $this_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( $this_public_query_vars ) { 
  3. // make filter magic happen here... 
  4. return $this_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).

/wp-includes/class-wp.php  
  1. $this->public_query_vars = apply_filters( 'query_vars', $this->public_query_vars );