is_active_sidebar

Filter Hook

Description

Filters whether a dynamic sidebar is considered "active".

Hook Information

File Location	`wp-includes/widgets.php` View on GitHub
Hook Type	Filter
Line Number	`997`

Hook Parameters

Type	Name	Description
`bool`	`$is_active_sidebar`	Whether or not the sidebar should be considered "active". In other words, whether the sidebar contains any widgets.
`int\|string`	`$index`	Index, name, or ID of the dynamic sidebar.

Usage Examples

Basic Usage

<?php
// Hook into is_active_sidebar
add_filter('is_active_sidebar', 'my_custom_filter', 10, 2);

function my_custom_filter($is_active_sidebar, $index) {
    // Your custom filtering logic here
    return $is_active_sidebar;
}

Source Code Context

wp-includes/widgets.php:997 - How this hook is used in WordPress core

<?php
 992  	 *
 993  	 * @param bool       $is_active_sidebar Whether or not the sidebar should be considered "active".
 994  	 *                                      In other words, whether the sidebar contains any widgets.
 995  	 * @param int|string $index             Index, name, or ID of the dynamic sidebar.
 996  	 */
 997  	return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index );
 998  }
 999  
1000  //
1001  // Internal Functions.
1002  //

PHP Documentation

<?php
/**
	 * 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.
	 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/widgets.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.