is_active_sidebar()

最后更新于：2021-11-27 07:53:28

is_active_sidebar( string|int$index)

Determines whether a sidebar contains widgets.

参数

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

响应

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

源文件

文件: gc-includes/widgets.php

function is_active_sidebar( $index ) {
	$index             = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index );
	$sidebars_widgets  = gc_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 );
}