wp_sidebar_description( string $id )

Retrieve description for a sidebar.


Description Description

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


Parameters Parameters

$id

(string) (Required) sidebar ID.


Top ↑

Return Return

(string|void) Sidebar description, if available.


Top ↑

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

Top ↑

Changelog Changelog

Changelog
Version Description
2.9.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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