WordPress.org

Languages: English • active sidebar 日本語 (Add your language)

Description

This Conditional Tag checks if a given sidebar is active (in use). This is a boolean function, meaning it returns either TRUE or FALSE.

Any sidebar that contains widgets will return TRUE, whereas any sidebar that does not contain any widgets will return FALSE.

Usage

 <?php is_active_sidebar( $index ); ?> 

Parameters

$index

(mixed) (required) Sidebar name or id.

Default: None

Return Values

(boolean) 

True if the sidebar is in use, otherwise the function returns false

Examples

Display different output depending on whether the sidebar is active or not.

<?php if ( is_active_sidebar( 'left-sidebar' ) ) { ?>
	<ul id="sidebar">
		<?php dynamic_sidebar( 'left-sidebar' ); ?>
	</ul>
<?php } ?>

in the "Twenty Ten" theme (3.0+)

• wp-content/themes/twentyten/sidebar.php
• wp-content/themes/twentyten/sidebar-footer.php

Change Log

Since: 2.8.0

Source File

is_active_sidebar() is located in wp-includes/widgets.php.

Related

Sidebars: is_active_sidebar(), is_dynamic_sidebar(), dynamic_sidebar(), register_sidebars(), register_sidebar(), unregister_sidebar(), wp_register_sidebar_widget(), wp_unregister_sidebar_widget(), wp_get_sidebars_widgets(), wp_set_sidebars_widgets()

• Article: Introduction to WordPress conditional functions
• Function: comments_open()
• Function: is_404()
• Function: is_admin()
• Function: is_admin_bar_showing()
• Function: is_archive()
• Function: is_attachment()
• Function: is_author()
• Function: is_category()
• Function: is_comments_popup()
• Function: is_date()
• Function: is_day()
• Function: is_feed()
• Function: is_front_page()
• Function: is_home()
• Function: is_local_attachment()
• Function: is_main_query
• Function: is_multi_author
• Function: is_month()
• Function: is_new_day()
• Function: is_page()
• Function: is_page_template()
• Function: is_paged()
• Function: is_plugin_active()
• Function: is_plugin_active_for_network()
• Function: is_plugin_inactive()
• Function: is_plugin_page()
• Function: is_post_type_archive()
• Function: is_preview()
• Function: is_search()
• Function: is_single()
• Function: is_singular()
• Function: is_sticky()
• Function: is_tag()
• Function: is_tax()
• Function: is_taxonomy_hierarchical()
• Function: is_time()
• Function: is_trackback()
• Function: is_year()
• Function: in_category()
• Function: in_the_loop()
• Function: is_active_sidebar()
• Function: is_active_widget()
• Function: is_blog_installed()
• Function: is_rtl()
• Function: is_dynamic_sidebar()
• Function: is_user_logged_in()
• Function: has_excerpt()
• Function: has_post_thumbnail()
• Function: has_tag()
• Function: pings_open()
• Function: email_exists()
• Function: post_type_exists()
• Function: taxonomy_exists()
• Function: term_exists()
• Function: username_exists()
• Function: wp_attachment_is_image()
• Function: wp_script_is()