wp_widget_description() WordPress Function
The wp_widget_description function displays a widget's description, if one is set. This function is only used for widgets in the admin area.
wp_widget_description( int|string $id ) #
Retrieve description for widget.
Description
When registering widgets, the options can also include ‘description’ that describes the widget for display on the widget administration panel or in the theme.
Parameters
- $id
(int|string)(Required)Widget ID.
Return
(string|void) Widget description, if available.
Source
File: wp-includes/widgets.php
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'] );
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |