W3cubDocs

/WordPress

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

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

$idint|stringrequired
Widget ID.

Return

string|void Widget description, if available.

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

Changelog

Version Description
2.5.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_widget_description