云策 WordPress 开发者社区

钩子文档

rest_prepare_sidebar

查看官方原文 ↗
💡 云策文档标注

概述

rest_prepare_sidebar 是一个 WordPress REST API 过滤器，用于修改侧边栏的响应数据。它允许开发者在侧边栏数据返回给客户端前进行自定义处理。

关键要点

  • 过滤器名称：rest_prepare_sidebar
  • 参数：$response（WP_REST_Response 对象）、$raw_sidebar（原始侧边栏数组）、$request（WP_REST_Request 对象）
  • 用途：过滤侧边栏的 REST API 响应，常用于 WP_REST_Sidebars_Controller::prepare_item_for_response() 方法中
  • 引入版本：WordPress 5.8.0
📄 原文内容

Filters the REST API response for a sidebar.

Parameters

$responseWP_REST_Response
The response object.
$raw_sidebararray
The raw sidebar data.
$requestWP_REST_Request
The request object.

Source

return apply_filters( 'rest_prepare_sidebar', $response, $raw_sidebar, $request );

View all references View on Trac View on GitHub

Used by Description
WP_REST_Sidebars_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

Prepares a single sidebar output for response.

Changelog

Version Description
5.8.0 Introduced.