Filter hook 'rest_user_collection_params'

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

Description

Filters REST API collection parameters for the users controller. This filter registers the collection parameter, but does not map the collection parameter to an internal WP_User_Query parameter. Use the `rest_user_query` filter to set WP_User_Query arguments.

Occurrences

Filename Line Number
wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 1622

Parameters

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

PHP Doc

/**
		 * Filters REST API collection parameters for the users controller.
		 *
		 * This filter registers the collection parameter, but does not map the
		 * collection parameter to an internal WP_User_Query parameter.  Use the
		 * `rest_user_query` filter to set WP_User_Query arguments.
		 *
		 * @since 4.7.0
		 *
		 * @param array $query_params JSON Schema-formatted collection parameters.
		 */