wpseek.com
Outil de recherche WordPress pour les développeurs et auteurs de thèmes



wp_widget_description › WordPress Function

Depuis2.5.0
Dépréciéen/a
› wp_widget_description ( $id )
Paramètres:
  • (int|string) $id Widget ID.
    Requis: Oui
Retourne:
  • (string|null) Widget description, if available.
Défini(e) dans:
Codex:

Retrieves description for widget.

When registering widgets, the options can also include 'description' that describes the widget for display on the widget administration panel or in the theme.


Fonctions en relation: wp_sidebar_description, get_file_description, tag_description, term_description, wp_get_script_tag

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;
}