wp_sidebar_description() WordPress Function
The wp_sidebar_description() function allows you to display a sidebar description. This is useful for providing additional information about the sidebar's widgets.
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
(string)(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' );
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |