On this page
apply_filters( 'rest_user_collection_params', array $query_params )
Filters REST API collection parameters for the users controller.
Description
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.
Parameters
$query_paramsarray-
JSON Schema-formatted collection parameters.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php. View all references
return apply_filters( 'rest_user_collection_params', $query_params );
Related
Used By
| Used By | Description |
|---|---|
| WP_REST_Users_Controller::get_collection_params() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php | Retrieves the query params for collections. |
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/rest_user_collection_params