WP_Customize_Widgets::tally_sidebars_via_is_active_sidebar_calls() WordPress Method

The WP_Customize_Widgets::tally_sidebars_via_is_active_sidebar_calls() method is used to tally the number of sidebars that are active on a page. This is done by calling the is_active_sidebar() method for each sidebar.

WP_Customize_Widgets::tally_sidebars_via_is_active_sidebar_calls( bool $is_active, string $sidebar_id ) #

Tallies the sidebars rendered via is_active_sidebar().


Description

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


Top ↑

Parameters

$is_active

(bool)(Required)Whether the sidebar is active.

$sidebar_id

(string)(Required)Sidebar ID.


Top ↑

Return

(bool) Whether the sidebar is active.


Top ↑

Source

File: wp-includes/class-wp-customize-widgets.php

	public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $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 'dynamic_sidebar_has_widgets' if we want to ensure that there
		 * is an area to drop widgets into, if the sidebar is empty.
		 */
		return $is_active;
	}


Top ↑

Changelog

Changelog
VersionDescription
3.9.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.