钩子文档

rest_prepare_plugin

💡 云策文档标注

概述

rest_prepare_plugin 是一个 WordPress REST API 过滤器,用于在插件数据返回给 REST API 响应前进行自定义处理。它允许开发者修改插件数据,适用于插件管理相关的 API 端点。

关键要点

  • 这是一个过滤器 Hook,名称为 rest_prepare_plugin,用于过滤插件数据。
  • 参数包括 $response(WP_REST_Response 对象)、$item(来自 get_plugin_data() 的插件数组)和 $request(WP_REST_Request 对象)。
  • 在 WP_REST_Plugins_Controller::prepare_item_for_response() 方法中使用,用于准备插件的 REST 响应。
  • 从 WordPress 5.5.0 版本开始引入。

📄 原文内容

Filters plugin data for a REST API response.

Parameters

$responseWP_REST_Response
The response object.
$itemarray
The plugin item from get_plugin_data().
$requestWP_REST_Request
The request object.

Source

return apply_filters( 'rest_prepare_plugin', $response, $item, $request );

Changelog

Version Description
5.5.0 Introduced.