Question

wp_sidebar_description( string $id )

Retrieve description for a sidebar.

---

description

When registering sidebars a ‘description’ parameter can be included that describes the sidebar for display on the widget administration panel.

---

参数

$id

(string) (Required) sidebar ID.

---

返回值

(string|void) Sidebar description, if available.

---

源代码

File: wp-includes/widgets.php

function wp_sidebar_description( $id ) {
	if ( !is_scalar($id) )
		return;

	global $wp_registered_sidebars;

	if ( isset($wp_registered_sidebars[$id]['description']) )
		return esc_html( $wp_registered_sidebars[$id]['description'] );
}

---

更新日志

Version	description
2.9.0	Introduced.

---

相关函数

Uses

• wp-includes/formatting.php: esc_html()

---

Used By

• wp-admin/includes/widgets.php: wp_list_widget_controls()