rest_user_query

Filters WP_User_Query arguments when querying users via the REST API.

Description

apply_filters( 'rest_user_query', (array) $prepared_args, (WP_REST_Request) $request ); 

Parameters (2)

0. $prepared_args (array)
Array of arguments for WP_User_Query.
1. $request (WP_REST_Request)
The current request.

Usage

To run the hook, copy the example below.
  1. $prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request ); 
  2.  
  3. if ( !empty( $prepared_args ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the rest_user_query callback 
  2. function filter_rest_user_query( $prepared_args, $request ) { 
  3. // make filter magic happen here... 
  4. return $prepared_args
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_user_query', 'filter_rest_user_query', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_user_query', 'filter_rest_user_query', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php  
  1. $prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request );