rest_{$this->taxonomy}_collection_params WordPress Filter Hook
The rest_{$this->taxonomy}_collection_params hook allows you to modify the parameters used to query the collection of terms for a given taxonomy. This can be useful for adding extra fields to the response or changing the order of the terms.
apply_filters( "rest_{$this->taxonomy}_collection_params", array $query_params , WP_Taxonomy $taxonomy ) #
Filters collection parameters for the terms controller.
Description
The dynamic part of the filter $this->taxonomy refers to the taxonomy slug for the controller.
This filter registers the collection parameter, but does not map the collection parameter to an internal WP_Term_Query parameter. Use the `rest_{$this->taxonomy}_query` filter to set WP_Term_Query parameters.
Parameters
- $query_params
(array)JSON Schema-formatted collection parameters.
- $taxonomy
(WP_Taxonomy)Taxonomy object.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |