rest_<post_type>_query

Filters the query arguments for a request.

Description

apply_filters( 'rest_<post_type>_query', (array) $args, (WP_REST_Request) $request ); 

Enables adding extra arguments or setting defaults for a post collection request.

Parameters (2)

0. $args (array)
Key value array of query var to query value.
1. $request (WP_REST_Request)
The request used.

Usage

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

Defined (1)

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

/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php  
  1. $args = apply_filters( "rest_{$this->post_type}_query", $args, $request );