wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_sidebar_description › WordPress Function

Since2.9.0
Deprecatedn/a
› wp_sidebar_description ( $id )
Parameters:
  • (string) $id sidebar ID.
    Required: Yes
Returns:
  • (string|void) Sidebar description, if available.
Defined at:
Codex:

Retrieve description for a sidebar.

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


Related Functions: wp_widget_description, term_description, tag_description, wp_get_extension_error_description, the_author_description

Source 

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' );
	}
}