rest_(post_type)_collection_params filter-hookWP 4.7.0

Filters collection parameters for the posts controller.

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.

Usage

add_filter( 'rest_(post_type)_collection_params', 'wp_kama_rest_post_type_collection_params_filter', 10, 2 );

/**
 * Function for `rest_(post_type)_collection_params` filter-hook.
 * 
 * @param array        $query_params JSON Schema-formatted collection parameters.
 * @param WP_Post_Type $post_type    Post type object.
 *
 * @return array
 */
function wp_kama_rest_post_type_collection_params_filter( $query_params, $post_type ){

	// filter...
	return $query_params;
}
$query_params(array)
JSON Schema-formatted collection parameters.
$post_type(WP_Post_Type)
Post type object.

Changelog

Since 4.7.0 Introduced.

Where the hook is called

WP_REST_Posts_Controller::get_collection_params()
rest_(post_type)_collection_params
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2891
return apply_filters( "rest_{$this->post_type}_collection_params", $query_params, $post_type );

Where the hook is used in WordPress

Usage not found.