钩子文档

rest_post_search_query

💡 云策文档标注

概述

rest_post_search_query 是一个 WordPress REST API 过滤器,用于修改文章搜索请求的查询参数。它允许开发者在处理搜索请求时添加额外参数或设置默认值。

关键要点

  • 过滤器名称:rest_post_search_query
  • 用途:过滤 REST API 文章搜索请求的查询参数
  • 参数:$query_args(数组,查询变量键值对)和 $request(WP_REST_Request 对象)
  • 引入版本:WordPress 5.1.0
  • 相关函数:WP_REST_Post_Search_Handler::search_items()

代码示例

$query_args = apply_filters( 'rest_post_search_query', $query_args, $request );

📄 原文内容

Filters the query arguments for a REST API post search request.

Description

Enables adding extra arguments or setting defaults for a post 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_search_query', $query_args, $request );

Changelog

Version Description
5.1.0 Introduced.