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.


Top ↑

Parameters

$query_params array
JSON Schema-formatted collection parameters.

Top ↑

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 );


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.