1. 首页
  2. WordPress钩子手册

is_active_sidebar

apply_filters( ‘is_active_sidebar’, bool $is_active_sidebar, int|string $index )

过滤钩子:过滤动态侧边栏是否被认为是“活动的”。
Filter Hook: Filters whether a dynamic sidebar is considered “active”.

目录锚点:#参数#源码


参数(Parameters)

参数 类型 说明
$is_active_sidebar (bool) 侧边栏是否应被视为“活动”。换句话说,侧边栏是否包含任何小部件。
$index (int | string) 动态侧边栏的索引、名称或ID。

源码(Source)

/**
 * Whether a sidebar is in use.
 *
 * @since 2.8.0
 *
 * @param string|int $index Sidebar name, id or number to check.
 * @return bool true if the sidebar is in use, false otherwise.
 */
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] );

	/**
	 * Filter 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 );
}

/* Internal Functions */
更新版本 源码位置 使用 被使用
3.9.0 wp-includes/widgets.php:946 1 0

is_active_sidebar 为WP2原创文章,链接:https://www.wp2.cn/hook/is_active_sidebar-2/