rest_comment_query
云策文档标注
概述
rest_comment_query 是一个 WordPress REST API 钩子,用于在通过 REST API 查询评论时过滤 WP_Comment_Query 的参数。它允许开发者在执行评论查询前修改参数数组。
关键要点
- 这是一个过滤器钩子,应用于 WP_Comment_Query 的参数数组。
- 主要用于 REST API 中的评论查询,例如在 WP_REST_Comments_Controller::get_items() 方法中。
- 从 WordPress 4.7.0 版本开始引入。
代码示例
$prepared_args = apply_filters( 'rest_comment_query', $prepared_args, $request );
原文内容
Filters WP_Comment_Query arguments when querying comments via the REST API.
Parameters
$prepared_argsarray-
Array of arguments for WP_Comment_Query.
$requestWP_REST_Request-
The REST API request.
Source
$prepared_args = apply_filters( 'rest_comment_query', $prepared_args, $request );
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |