钩子文档

rest_prepare_block_pattern

💡 云策文档标注

概述

rest_prepare_block_pattern 是一个 WordPress REST API 过滤器,用于在块模式(block pattern)准备输出到 REST API 响应前修改响应对象。

关键要点

  • 过滤器名称:rest_prepare_block_pattern
  • 参数:$response(WP_REST_Response 对象)、$raw_pattern(原始块模式对象)、$request(WP_REST_Request 对象)
  • 用途:允许开发者在块模式数据通过 REST API 返回前进行自定义处理或修改
  • 相关函数:WP_REST_Pattern_Directory_Controller::prepare_item_for_response()
  • 引入版本:WordPress 5.8.0

📄 原文内容

Filters the REST API response for a block pattern.

Parameters

$responseWP_REST_Response
The response object.
$raw_patternobject
The unprepared block pattern.
$requestWP_REST_Request
The request object.

Source

return apply_filters( 'rest_prepare_block_pattern', $response, $raw_pattern, $request );

Changelog

Version Description
5.8.0 Introduced.