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.


Top ↑

Return

(string|void) Widget description, if available.


Top ↑

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

Top ↑

Changelog

Version Description
2.5.0 Introduced.