wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_widget_description › WordPress Function

Since2.5.0
Deprecatedn/a
› wp_widget_description ( $id )
Parameters:
  • (int|string) $id Widget ID.
    Required: Yes
Returns:
  • (string|void) Widget description, if available.
Defined at:
Codex:

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.


Related Functions: wp_sidebar_description, get_file_description, tag_description, term_description, wp_get_script_tag

Source 

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'] );
	}
}