rest_comment_collection_params – Hook

apply_filters( ‘rest_comment_collection_params’, array $query_params )

Filters REST API collection parameters for the comments controller.

Description

This filter registers the collection parameter, but does not map the collection parameter to an internal WP_Comment_Query parameter. Use the rest_comment_query filter to set WP_Comment_Query parameters.

Parameters

$query_paramsarray: JSON Schema-formatted collection parameters.

Source

return apply_filters( 'rest_comment_collection_params', $query_params );

View all references View on Trac View on GitHub

Used by	Description
WP_REST_Comments_Controller::get_collection_params()`wp-includes/rest-api/endpoints/class-wp-rest-comments-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.