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

Description

Parameters

$idint|string

Widget ID.

Return

string|void

Widget description, if available.

Uses · 1

• esc_html()Escaping for HTML blocks.

Used by · 1

• wp_widget_control()Meta widget used to display the control form for a widget.

Source

View on Trac ↗View on GitHub ↗

451function wp_widget_description( $id ) {452	if ( ! is_scalar( $id ) ) {453		return;454	}455 456	global $wp_registered_widgets;457 458	if ( isset( $wp_registered_widgets[ $id ]['description'] ) ) {459		return esc_html( $wp_registered_widgets[ $id ]['description'] );460	}461}

History

Introduced in 2.5.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/widgets.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.