widget_display_callback
Filter HookDescription
Filters the settings for a particular widget instance. Returning false will effectively short-circuit display of the widget.Hook Information
File Location |
wp-includes/class-wp-widget.php
View on GitHub
|
Hook Type | Filter |
Line Number | 383 |
Hook Parameters
Type | Name | Description |
---|---|---|
array
|
$instance
|
The current widget instance's settings. |
WP_Widget
|
$widget
|
The current widget instance. |
array
|
$args
|
An array of default widget arguments. |
Usage Examples
Basic Usage
<?php
// Hook into widget_display_callback
add_filter('widget_display_callback', 'my_custom_filter', 10, 3);
function my_custom_filter($instance, $widget, $args) {
// Your custom filtering logic here
return $instance;
}
Source Code Context
wp-includes/class-wp-widget.php:383
- How this hook is used in WordPress core
<?php
378 *
379 * @param array $instance The current widget instance's settings.
380 * @param WP_Widget $widget The current widget instance.
381 * @param array $args An array of default widget arguments.
382 */
383 $instance = apply_filters( 'widget_display_callback', $instance, $this, $args );
384
385 if ( false === $instance ) {
386 return;
387 }
388
PHP Documentation
<?php
/**
* Filters the settings for a particular widget instance.
*
* Returning false will effectively short-circuit display of the widget.
*
* @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.
*/
Quick Info
- Hook Type: Filter
- Parameters: 3
- File: wp-includes/class-wp-widget.php
Related Hooks
Related hooks will be displayed here in future updates.