rest_(taxonomy)_collection_params filter-hook . WP 4.7.0
Filters collection parameters for the terms controller.
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.
Usage
add_filter( 'rest_(taxonomy)_collection_params', 'filter_function_name_9675', 10, 2 ); function filter_function_name_9675( $query_params, $taxonomy ){ // filter... return $query_params; }
- $query_params(array)
- JSON Schema-formatted collection parameters.
- $taxonomy(WP_Taxonomy)
- Taxonomy object.
Changelog
Since 4.7.0 | Introduced. |
Where the hook is called
rest_(taxonomy)_collection_params
wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php 1098
return apply_filters( "rest_{$this->taxonomy}_collection_params", $query_params, $taxonomy );