apply_filters( "rest_{$this->post_type}_collection_params", array $query_params, WP_Post_Type $post_type )
- Since
- 4.7.0
Filters collection parameters for the posts controller.
Description
The dynamic part of the filter $this->post_type refers to the post type slug for the controller.
This filter registers the collection parameter, but does not map the collection parameter to an internal WPQuery parameter. Use the `rest{$this->post_type}_query` filter to set WP_Query parameters.
Compatibility
- WordPress
- since 4.7.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$query_paramsarray- JSON Schema-formatted collection parameters.
$post_typeWP_Post_Type- Post type object.
Where this hook fires · 1
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:3179WP_REST_Posts_Controller::get_collection_params()
Source code
* * @since 4.7.0 * * @param array $query_params JSON Schema-formatted collection parameters. * @param WP_Post_Type $post_type Post type object. */ return apply_filters( "rest_{$this->post_type}_collection_params", $query_params, $post_type ); } /** * Sanitizes and validates the list of post statuses, including whether the * user can query private statuses. *Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.