wppaste
WordPress

apply_filters( 'rest_user_collection_params', array $query_params )

Since
4.7.0
Filters REST API collection parameters for the users controller.

Description

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

Compatibility

WordPress
since 4.7.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$query_paramsarray
JSON Schema-formatted collection parameters.

Where this hook fires · 1

  • wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php:1680WP_REST_Users_Controller::get_collection_params()

Source code

View on Trac View on GitHub 

		 * `rest_user_query` filter to set WP_User_Query arguments.		 *		 * @since 4.7.0		 *		 * @param array $query_params JSON Schema-formatted collection parameters.		 */		return apply_filters( 'rest_user_collection_params', $query_params );	}}

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.