wp_widget_description( int|string $id ): string|null

Retrieves 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

$idint|stringrequired: Widget ID.

Return

string|null Widget description, if available.

Source

function wp_widget_description( $id ) {
	if ( ! is_scalar( $id ) ) {
		return null;
	}

	global $wp_registered_widgets;

	if ( isset( $wp_registered_widgets[ $id ]['description'] ) ) {
		return esc_html( $wp_registered_widgets[ $id ]['description'] );
	}
	return null;
}

View all references View on Trac View on GitHub

Uses	Description
esc_html()`wp-includes/formatting.php`	Escaping for HTML blocks.

Used by	Description
wp_widget_control()`wp-admin/includes/widgets.php`	Meta widget used to display the control form for a widget.

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.