rest_(post_type)_query │ filter-hook │ WP 4.7.0

Filters WP_Query arguments when querying posts via the REST API.

The dynamic portion of the hook name, $this->post_type, refers to the post type slug.

Possible hook names include:

• rest_post_query
• rest_page_query
• rest_attachment_query

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

Usage

add_filter( 'rest_(post_type)_query', 'wp_kama_rest_post_type_query_filter', 10, 2 );

/**
 * Function for `rest_(post_type)_query` filter-hook.
 * 
 * @param array           $args    Array of arguments for WP_Query.
 * @param WP_REST_Request $request The REST API request.
 *
 * @return array
 */
function wp_kama_rest_post_type_query_filter( $args, $request ){

	// filter...
	return $args;
}

$args(array)

Array of arguments for WP_Query.

$request(WP_REST_Request)

The REST API request.

Changelog

Where the hook is called

$args       = apply_filters( "rest_{$this->post_type}_query", $args, $request );

Where the hook is used in WordPress