wp_sidebar_description() WP 2.9.0
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.
No Hooks.
Return
String/null. Sidebar description, if available.
Usage
wp_sidebar_description( $id );
- $id(string) (required)
- sidebar ID.
Notes
- Global. Array. $wp_registered_sidebars Registered sidebars.
Changelog
Since 2.9.0 | Introduced. |
Code of wp_sidebar_description() wp sidebar description WP 5.6
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' );
}
}