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.

$value = apply_filters( 'rest_query_var-{$key}', $value ); 
                         
if ( !empty( $value ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the rest_query_var-<key> callback 
function filter_rest_query_var_key( $value ) { 
    // make filter magic happen here... 
    return $value; 
}; 
         
// add the filter 
add_filter( "rest_query_var-{$key}", 'filter_rest_query_var_key', 10, 1 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( "rest_query_var-{$key}", 'filter_rest_query_var_key', 10, 1 );