apply_filters( "rest_{$this->taxonomy}_query", array $prepared_args, WP_REST_Request $request )

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

Description

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.

Parameters

$prepared_args

(array) Array of arguments for get_terms().

$request

(WP_REST_Request) The REST API request.

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

View on Trac

Changelog

Version Description
4.7.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/rest_this-taxonomy_query