函数文档

is_registered_sidebar()

💡 云策文档标注

概述

is_registered_sidebar() 函数用于检查指定侧边栏是否已注册。它通过查询全局变量 $wp_registered_sidebars 来确定侧边栏的存在状态。

关键要点

  • 参数 $sidebar_id 为字符串或整数,表示侧边栏注册时的 ID,是必填项。
  • 返回布尔值:如果侧边栏已注册则返回 true,否则返回 false。
  • 函数内部实现基于 isset() 检查 $wp_registered_sidebars[$sidebar_id] 是否存在。
  • 该函数自 WordPress 4.4.0 版本引入。

代码示例

function is_registered_sidebar( $sidebar_id ) {
	global $wp_registered_sidebars;

	return isset( $wp_registered_sidebars[ $sidebar_id ] );
}

相关函数

  • register_sidebars():用于创建多个侧边栏。
  • WP_Customize_Widgets 类中的多个方法,如 customize_register(),用于在 Customizer 中注册侧边栏和小部件设置。

📄 原文内容

Checks if a sidebar is registered.

Parameters

$sidebar_idstring|intrequired
The ID of the sidebar when it was registered.

Return

bool True if the sidebar is registered, false otherwise.

Source

function is_registered_sidebar( $sidebar_id ) {
	global $wp_registered_sidebars;

	return isset( $wp_registered_sidebars[ $sidebar_id ] );
}

Changelog

Version Description
4.4.0 Introduced.