W3cubDocs

/WordPress

WP_Widget::display_callback( array $args, int|array $widget_args = 1 )

Generates the actual widget content (Do NOT override).

Description

Finds the instance and calls WP_Widget::widget().

Parameters

$args

(array) (Required) Display arguments. See WP_Widget::widget() for information on accepted arguments.

$widget_args

(int|array) (Optional) Internal order number of the widget instance, or array of multi-widget arguments.

  • 'number'
    (int) Number increment used for multiples of the same widget.

Default value: 1

Source

File: wp-includes/class-wp-widget.php 

public function display_callback( $args, $widget_args = 1 ) {
		if ( is_numeric( $widget_args ) ) {
			$widget_args = array( 'number' => $widget_args );
		}

		$widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
		$this->_set( $widget_args['number'] );
		$instances = $this->get_settings();

		if ( array_key_exists( $this->number, $instances ) ) {
			$instance = $instances[ $this->number ];

			/**
			 * 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 $this     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();
			if ( $this->is_preview() && ! $was_cache_addition_suspended ) {
				wp_suspend_cache_addition( true );
			}

			$this->widget( $args, $instance );

			if ( $this->is_preview() ) {
				wp_suspend_cache_addition( $was_cache_addition_suspended );
			}
		}
	}

Uses

Uses Description
wp-includes/functions.php: wp_suspend_cache_addition()

Temporarily suspend cache additions.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/class-wp-widget.php: WP_Widget::get_settings()

Retrieves the settings for all instances of the widget class.
wp-includes/class-wp-widget.php: widget_display_callback

Filters the settings for a particular widget instance.
wp-includes/class-wp-widget.php: WP_Widget::_set()

Sets the internal order number for the widget instance.
wp-includes/class-wp-widget.php: WP_Widget::is_preview()

Determines whether the current request is inside the Customizer preview.
wp-includes/class-wp-widget.php: WP_Widget::widget()

Echoes the widget content.

Changelog

Version Description
2.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_widget/display_callback