WordPress at Your Fingertips
filter is not described

rest_(taxonomy)_query filter-hook . WP 4.7.0

Filters get_terms() arguments when querying terms via the REST API.

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

Possible hook names include:

  • rest_category_query
  • rest_post_tag_query

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

Usage

add_filter( 'rest_(taxonomy)_query', 'filter_function_name_5560', 10, 2 );
function filter_function_name_5560( $prepared_args, $request ){
	// filter...

	return $prepared_args;
}
$prepared_args(array)
Array of arguments for get_terms().
$request(WP_REST_Request)
The REST API request.

Changelog

Since 4.7.0 Introduced.

Where the hook is called

WP_REST_Terms_Controller::get_items()
rest_(taxonomy)_query
wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php 255
$prepared_args = apply_filters( "rest_{$this->taxonomy}_query", $prepared_args, $request );

Where in WP core the hook is used WordPress

Usage not found.