rest_user_collection_params
云策文档标注
概述
rest_user_collection_params 是一个 WordPress REST API 过滤器，用于修改用户控制器（WP_REST_Users_Controller）的集合参数。它允许开发者自定义用户集合查询的 JSON Schema 参数，但不直接映射到 WP_User_Query 参数。
关键要点
- 此过滤器用于注册和调整 REST API 用户集合的查询参数，基于 JSON Schema 格式。
- 它不自动将参数映射到 WP_User_Query 参数；如需设置 WP_User_Query 参数，应使用 rest_user_query 过滤器。
- 过滤器在 WP_REST_Users_Controller::get_collection_params() 方法中被调用，用于检索集合的查询参数。
- 从 WordPress 4.7.0 版本开始引入。
代码示例
return apply_filters( 'rest_user_collection_params', $query_params );
原文内容
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.
Parameters
$query_paramsarray-
JSON Schema-formatted collection parameters.
Source
return apply_filters( 'rest_user_collection_params', $query_params );
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |