钩子文档

widget_display_callback

💡 云策文档标注

概述

widget_display_callback 是一个 WordPress 过滤器钩子,用于过滤特定小部件实例的设置。返回 false 可以阻止小部件的显示。

关键要点

  • 这是一个过滤器钩子,用于修改小部件实例的设置。
  • 返回 false 可以短路径小部件的显示。
  • 参数包括 $instance(当前小部件设置)、$widget(当前小部件实例)和 $args(默认小部件参数)。
  • 在 WP_Widget::display_callback() 和 the_widget() 中使用。
  • 自 WordPress 2.8.0 版本引入。

代码示例

$instance = apply_filters( 'widget_display_callback', $instance, $this, $args );

📄 原文内容

Filters the settings for a particular widget instance.

Description

Returning false will effectively short-circuit display of the widget.

Parameters

$instancearray
The current widget instance’s settings.
$widgetWP_Widget
The current widget instance.
$argsarray
An array of default widget arguments.

Source

$instance = apply_filters( 'widget_display_callback', $instance, $this, $args );

Changelog

Version Description
2.8.0 Introduced.