rest_(post_type)_collection_params
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.
Использование
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(массив)
- JSON Schema-formatted collection parameters.
- $post_type(WP_Post_Type)
- Post type object.
Список изменений
| С версии 4.7.0 | Введена. |
Где вызывается хук
rest_(post_type)_collection_params
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 3120
return apply_filters( "rest_{$this->post_type}_collection_params", $query_params, $post_type );