wppaste
WordPress

apply_filters( 'widget_display_callback', array $instance, WP_Widget $widget, array $args )

Since
2.8.0
Filters the settings for a particular widget instance.

Description

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

Compatibility

WordPress
since 2.8.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

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

Where this hook fires · 2

  • wp-includes/class-wp-widget.php:383WP_Widget::display_callback()
  • wp-includes/widgets.php:1251the_widget()

Source code

<?php			 * @since 2.8.0			 *			 * @param array     $instance The current widget instance's settings.			 * @param WP_Widget $widget   The current widget instance.			 * @param array     $args     An array of default widget arguments.			 */			$instance = apply_filters( 'widget_display_callback', $instance, $this, $args ); 			if ( false === $instance ) {				return;			} 			$was_cache_addition_suspended = wp_suspend_cache_addition();

Changelog

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.