rest_user_query filter-hook . WP 4.7.0
Filters WP_User_Query arguments when querying users via the REST API.
Usage
add_filter( 'rest_user_query', 'filter_function_name_7919', 10, 2 ); function filter_function_name_7919( $prepared_args, $request ){ // filter... return $prepared_args; }
- $prepared_args(array)
- Array of arguments for WP_User_Query.
- $request(WP_REST_Request)
- The current request.
Changelog
Since 4.7.0 | Introduced. |
Where the hook is called
rest_user_query
wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 317
$prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request );