is_active_sidebar()
is_active_sidebar( string|int $index ) 确定是否正在使用边栏。Deter…
is_active_sidebar( string|int $index )
确定是否正在使用边栏。
Determines whether a sidebar is in use.
目录锚点:#说明#参数#返回#源码#笔记
说明(Description)
有关此主题函数和类似主题函数的更多信息,请参阅主题开发人员手册中的条件标记文章。
参数(Parameters)
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
$index | (string | int) | 必需 | 要检查的边栏名称、id或编号。 |
返回(Return)
(bool)如果边栏正在使用,则为true,否则为false。
源码(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 */
更新版本 | 源码位置 | 使用 | 被使用 |
---|---|---|---|
2.8.0 | wp-includes/widgets.php:932 | 0 | 4 |
笔记(Notes)
例子
在描述中:“正在使用”意味着侧边栏包含小部件。
请注意,如果在调用register_侧边栏时未明确声明ID,则不能按侧边栏名称进行搜索,甚至只有当ID正好是sanitize_title($sidebar_name)的值时才可以按侧边栏名称进行搜索。
类别:WordPress 函数手册、
本文收集自互联网,转载请注明来源。
如有侵权,请联系 wper_net@163.com 删除。
还没有任何评论,赶紧来占个楼吧!