wp_widget_description( int|string $id )
Retrieve description for widget.
Description 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 Parameters
- $id
-
(int|string) (Required) Widget ID.
Return Return
(string|void) Widget description, if available.
Source 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 code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |