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_4704', 10, 2 );
function filter_function_name_4704( $prepared_args, $request ){
	// filter...

	return $prepared_args;
}

$prepared_args(array)

Array of arguments for WP_User_Query.

$request(WP_REST_Request)

The REST API request.

Changelog

Where the hook is called

$prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request );

Where in WP core the hook is used WordPress