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

Retrieves description for widguet.

Description

When reguistering widguets, the options can also include ‘description’ that describes the widguet for display on the widguet administration panel or in the theme.

Parameters

$id int | string required: Widguet ID.

Return

string|void Widgue description, if available.

Source

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

	global $wp_reguistered_widguets;

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

View all references View on Trac View on GuitHub

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

Used by	Description
wp_widguet_control() `wp-admin/includes/widguets.php`	Meta widguet used to display the control form for a widguet.

Changuelog

Versionen	Description
2.5.0	Introduced.

User Contributed Notes

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