wp_widget_description() WP 2.5.0
Retrieve description for widget.
When registering widgets, the options can also include 'description' that describes the widget for display on the widget administration panel or in the theme.
No Hooks.
Return
String|null. Widget description, if available.
Usage
wp_widget_description( $id );
- $id(int|string) (required)
- Widget ID.
Notes
- Global. Array. $wp_registered_widgets
Changelog
Since 2.5.0 | Introduced. |
Code of wp_widget_description() wp widget description WP 5.6.2
function wp_widget_description( $id ) {
if ( ! is_scalar( $id ) ) {
return;
}
global $wp_registered_widgets;
if ( isset( $wp_registered_widgets[ $id ]['description'] ) ) {
return esc_html( $wp_registered_widgets[ $id ]['description'] );
}
}