Filter hook 'rest_comment_collection_params'

in WP Core File wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php at line 1696

Description

Filters REST API collection parameters for the comments controller. 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.

Occurrences

Filename Line Number
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 1696

Parameters

Type Name Description
array $query_params JSON Schema-formatted collection parameters.

PHP Doc

/**
		 * Filters REST API collection parameters for the comments controller.
		 *
		 * 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.
		 *
		 * @since 4.7.0
		 *
		 * @param array $query_params JSON Schema-formatted collection parameters.
		 */