rest_user_collection_params │ filter-hook │ WP 4.7.0

Filters REST API collection parameters for the users controller.

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 to set WP_User_Query arguments.

Usage

add_filter( 'rest_user_collection_params', 'wp_kama_rest_user_collection_params_filter' );

/**
 * Function for `rest_user_collection_params` filter-hook.
 * 
 * @param array $query_params JSON Schema-formatted collection parameters.
 *
 * @return array
 */
function wp_kama_rest_user_collection_params_filter( $query_params ){

	// filter...
	return $query_params;
}

$query_params(array)

JSON Schema-formatted collection parameters.

Changelog

Where the hook is called

return apply_filters( 'rest_user_collection_params', $query_params );

Where the hook is used in WordPress