wp_sidebar_description() – Function | Developer.WordPress.org

wp_sidebar_description( string $id ): string|void

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

$idstringrequired: sidebar ID.

Return

string|void Sidebar description, if available.

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

View all references View on Trac View on GitHub

Uses	Description
wp_kses()`wp-includes/kses.php`	Filters text content and strips out disallowed HTML.

Used by	Description
WP_REST_Sidebars_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php`	Prepares a single sidebar output for response.
wp_list_widget_controls()`wp-admin/includes/widgets.php`	Show the widgets and their settings for a sidebar.

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.