rest_{$this->taxonomy}_collection_params – Hook

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_paramsarray: JSON Schema-formatted collection parameters.
$taxonomyWP_Taxonomy: Taxonomy object.

Source

return apply_filters( "rest_{$this->taxonomy}_collection_params", $query_params, $taxonomy );

View all references View on Trac View on GitHub

Used by	Description
WP_REST_Terms_Controller::get_collection_params()`wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php`	Retrieves the query params for collections.

Changelog

Version	Description
4.7.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.