wp_sidebar_description() │ WP 2.9.0

Retrieves description for a sidebar.

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

No Hooks.

Returns

string|null. Sidebar description, if available.

Usage

wp_sidebar_description( $id );

$id(string) (required)

sidebar ID.

Notes

Changelog

wp_sidebar_description() wp sidebar description code ^{WP 7.1}

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

	global $wp_registered_sidebars;

	if ( isset( $wp_registered_sidebars[ $id ]['description'] ) ) {
		return wp_kses( $wp_registered_sidebars[ $id ]['description'], 'sidebar_description' );
	}
	return null;
}