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.


Parameters

$id

(Required) sidebar ID.


Return

(string|void) Sidebar description, if available.


Source

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 wp_kses( $wp_registered_sidebars[ $id ]['description'], 'sidebar_description' );
	}
}


Changelog

Changelog
Version Description
WP-2.9.0 Introduced.