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 Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/formatting.php: esc_html()

Escaping for HTML blocks.

Used By

Used By
Used By Description
wp-admin/includes/widgets.php: wp_widget_control()

Meta widget used to display the control form for a widget.

Changelog

Changelog
Version Description
WP-2.5.0 Introduced.