钩子文档

rest_block_directory_collection_params

💡 云策文档标注

概述

此文档介绍 rest_block_directory_collection_params 过滤器,用于修改 WordPress REST API 中块目录控制器的集合参数。它允许开发者自定义 JSON Schema 格式的查询参数。

关键要点

  • rest_block_directory_collection_params 是一个过滤器,用于调整块目录控制器的 REST API 集合参数。
  • 参数 $query_params 是一个数组,包含 JSON Schema 格式的集合参数。
  • 此过滤器在 WP_REST_Block_Directory_Controller::get_collection_params() 方法中使用,用于检索块集合的搜索参数。
  • 该过滤器从 WordPress 5.5.0 版本开始引入。

📄 原文内容

Filters REST API collection parameters for the block directory controller.

Parameters

$query_paramsarray
JSON Schema-formatted collection parameters.

Source

return apply_filters( 'rest_block_directory_collection_params', $query_params );

Changelog

Version Description
5.5.0 Introduced.