钩子文档

wp_rest_search_handlers

💡 云策文档标注

概述

此文档介绍 WordPress REST API 搜索控制器中使用的 wp_rest_search_handlers 过滤器,允许开发者自定义搜索处理程序列表。默认仅包含文章处理程序。

关键要点

  • wp_rest_search_handlers 是一个过滤器,用于修改 REST 搜索控制器中的搜索处理程序数组。
  • 每个搜索处理程序必须是 WP_REST_Search_Handler 类的实例。
  • 默认配置仅包含一个用于文章的处理程序。
  • 此过滤器在 WordPress 5.0.0 版本中引入。

代码示例

$search_handlers = apply_filters( 'wp_rest_search_handlers', $search_handlers );

注意事项

  • 确保自定义的搜索处理程序类正确扩展 WP_REST_Search_Handler 类。
  • 此过滤器在 create_initial_rest_routes() 函数中用于注册默认 REST API 路由。

📄 原文内容

Filters the search handlers to use in the REST search controller.

Parameters

$search_handlersarray
List of search handlers to use in the controller. Each search handler instance must extend the WP_REST_Search_Handler class.
Default is only a handler for posts.

Source

$search_handlers = apply_filters( 'wp_rest_search_handlers', $search_handlers );

Changelog

Version Description
5.0.0 Introduced.