rest_query_var-<key>

Filters the query_vars used in get_items() for the constructed query.

Description

apply_filters( 'rest_query_var-<key>', (string) $value ); 

The dynamic portion(s) of the hook name refer to the query_var key.

Parameters (1)

0. $value (string)
The query_var value.

Usage

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

Defined (1)

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

/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php  
  1. $query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value );