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', 'wp_kama_rest_user_query_filter', 10, 2 );

/**
 * Function for `rest_user_query` filter-hook.
 * 
 * @param array           $prepared_args Array of arguments for WP_User_Query.
 * @param WP_REST_Request $request       The REST API request.
 *
 * @return array
 */
function wp_kama_rest_user_query_filter( $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 the hook is used in WordPress