WP_Customize_Widgets::tally_sidebars_via_dynamic_sidebar_calls() – Method

WP_Customize_Widgets::tally_sidebars_via_dynamic_sidebar_calls( bool $has_widgets, string $sidebar_id ): bool

Tallies the sidebars rendered via dynamic_sidebar() .

Description

Keep track of the times that dynamic_sidebar() is called in the template, and assume this means the sidebar would be rendered on the template if there were widgets populating it.

Parameters

$has_widgetsboolrequired: Whether the current sidebar has widgets.
$sidebar_idstringrequired: Sidebar ID.

Return

bool Whether the current sidebar has widgets.

Source

public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) {
	if ( is_registered_sidebar( $sidebar_id ) ) {
		$this->rendered_sidebars[ $sidebar_id ] = true;
	}

	/*
	 * We may need to force this to true, and also force-true the value
	 * for 'is_active_sidebar' if we want to ensure there is an area to
	 * drop widgets into, if the sidebar is empty.
	 */
	return $has_widgets;
}

View all references View on Trac View on GitHub

Uses	Description
is_registered_sidebar()`wp-includes/widgets.php`	Checks if a sidebar is registered.

Changelog

Version	Description
3.9.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.