钩子文档

widget_form_callback

💡 云策文档标注

概述

widget_form_callback 是一个 WordPress 过滤器,用于在显示小部件控制表单之前过滤其设置实例。返回 false 可以阻止控制表单的显示。

关键要点

  • 这是一个过滤器钩子,允许开发者在渲染小部件控制表单前修改或拦截设置数据。
  • 参数包括 $instance(当前小部件设置数组)和 $widget(当前 WP_Widget 实例)。
  • 返回 false 会短路控制表单的显示,常用于条件性隐藏表单。

代码示例

$instance = apply_filters( 'widget_form_callback', $instance, $this );

注意事项

  • 此过滤器在 WP_Widget::form_callback() 方法中使用,不应被覆盖。
  • 相关函数包括 WP_REST_Widget_Types_Controller::get_widget_form() 用于 REST API 表单预览。
  • 自 WordPress 2.8.0 版本引入。

📄 原文内容

Filters the widget instance’s settings before displaying the control form.

Description

Returning false effectively short-circuits display of the control form.

Parameters

$instancearray
The current widget instance’s settings.
$widgetWP_Widget
The current widget instance.

Source

$instance = apply_filters( 'widget_form_callback', $instance, $this );

Changelog

Version Description
2.8.0 Introduced.