rest_post_format_search_query
云策文档标注
概述
此文档介绍 WordPress REST API 中用于过滤文章格式搜索查询参数的 Hook。它允许开发者在处理文章格式搜索请求时，修改或添加查询参数。
关键要点
- Hook 名称：rest_post_format_search_query
- 用途：过滤 REST API 文章格式搜索请求的查询参数，支持添加额外参数或设置默认值
- 参数：$query_args（数组，查询变量键值对）和 $request（WP_REST_Request 对象，当前请求）
- 引入版本：WordPress 5.6.0
代码示例
$query_args = apply_filters( 'rest_post_format_search_query', $query_args, $request );注意事项
- 此 Hook 主要用于 WP_REST_Post_Format_Search_Handler::search_items() 方法中，处理文章格式搜索逻辑
- 开发者应确保修改 $query_args 时符合 WordPress 查询标准，避免破坏搜索功能
原文内容
Filters the query arguments for a REST API post format search request.
Description
Enables adding extra arguments or setting defaults for a post format search request.
Parameters
$query_argsarray-
Key value array of query var to query value.
$requestWP_REST_Request-
The request used.
Source
$query_args = apply_filters( 'rest_post_format_search_query', $query_args, $request );
Changelog
| Version | Description |
|---|---|
| 5.6.0 | Introduced. |