rest_{$this->taxonomy}_collection_params
云策文档标注
概述
此过滤器用于为术语控制器（terms controller）的集合参数（collection parameters）提供动态过滤，基于分类法（taxonomy）slug。它注册集合参数但不映射到内部 WP_Term_Query 参数，需使用 rest_{$this->taxonomy}_query 过滤器进行映射。
关键要点
- 过滤器名称：rest_{$this->taxonomy}_collection_params，其中 $this->taxonomy 是动态分类法 slug。
- 功能：过滤术语控制器的集合参数，参数为 JSON Schema 格式的数组 $query_params 和 WP_Taxonomy 对象 $taxonomy。
- 注意事项：此过滤器仅注册参数，不映射到 WP_Term_Query；映射需使用 rest_{$this->taxonomy}_query 过滤器。
- 相关函数：WP_REST_Terms_Controller::get_collection_params() 用于检索集合参数。
- 版本历史：从 WordPress 4.7.0 版本引入。
代码示例
return apply_filters( "rest_{$this->taxonomy}_collection_params", $query_params, $taxonomy );
原文内容
Filters collection parameters for the terms controller.
Description
The dynamic part of the filter $this->taxonomy refers to the taxonomy slug for the controller.
This filter registers the collection parameter, but does not map the collection parameter to an internal WP_Term_Query parameter. Use the `rest_{$this->taxonomy}_query` filter to set WP_Term_Query parameters.
Parameters
$query_paramsarray-
JSON Schema-formatted collection parameters.
$taxonomyWP_Taxonomy-
Taxonomy object.
Source
return apply_filters( "rest_{$this->taxonomy}_collection_params", $query_params, $taxonomy );
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |