W3cubDocs

/WordPress

apply_filters( "rest_{$this->post_type}_collection_params", array $query_params, WP_Post_Type $post_type )

Filter 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 WP_Query parameter. Use the `rest_{$this->post_type}_query` filter to set WP_Query parameters.

Parameters

$query_params

(array) JSON Schema-formatted collection parameters.

$post_type

(WP_Post_Type) Post type object.

Source

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

View on Trac

Changelog

Version Description
4.7.0 Introduced.

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