钩子文档

rest_delete_widget

💡 云策文档标注

概述

rest_delete_widget 是一个 WordPress 动作钩子,在通过 REST API 删除小部件后触发,用于执行自定义操作。

关键要点

  • 触发时机:当小部件通过 REST API 被删除后立即执行。
  • 参数:包括小部件 ID、侧边栏 ID、REST 响应对象和请求对象,便于开发者访问相关数据。
  • 用途:常用于清理缓存、记录日志或更新相关数据等自定义功能。

代码示例

add_action( 'rest_delete_widget', function( $widget_id, $sidebar_id, $response, $request ) {
    // 自定义逻辑,例如记录删除日志
    error_log( "Widget deleted: ID $widget_id from sidebar $sidebar_id" );
}, 10, 4 );

📄 原文内容

Fires after a widget is deleted via the REST API.

Parameters

$widget_idstring
ID of the widget marked for deletion.
$sidebar_idstring
ID of the sidebar the widget was deleted from.
$responseWP_REST_Response|WP_Error
The response data, or WP_Error object on failure.
$requestWP_REST_Request
The request sent to the API.

Source

do_action( 'rest_delete_widget', $widget_id, $sidebar_id, $response, $request );

Changelog

Version Description
5.8.0 Introduced.