W3cubDocs

/WordPress

is_active_sidebar( string|int $index )

Determines whether a sidebar contains widgets.

Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Parameters

$index

(string|int) (Required) Sidebar name, id or number to check.

Return

(bool) True if the sidebar has widgets, false otherwise.

Source

File: wp-includes/widgets.php 

function is_active_sidebar( $index ) {
	$index             = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index );
	$sidebars_widgets  = wp_get_sidebars_widgets();
	$is_active_sidebar = ! empty( $sidebars_widgets[ $index ] );

	/**
	 * Filters whether a dynamic sidebar is considered "active".
	 *
	 * @since 3.9.0
	 *
	 * @param bool       $is_active_sidebar Whether or not the sidebar should be considered "active".
	 *                                      In other words, whether the sidebar contains any widgets.
	 * @param int|string $index             Index, name, or ID of the dynamic sidebar.
	 */
	return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index );
}

Uses

Uses Description
wp-includes/formatting.php: sanitize_title()

Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/widgets.php: wp_get_sidebars_widgets()

Retrieve full list of sidebars and their widget instance IDs.
wp-includes/widgets.php: is_active_sidebar

Filters whether a dynamic sidebar is considered “active”.

Changelog

Version Description
2.8.0 Introduced.

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