WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/wp widget description

Description

Retrieve 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.

Parameters

$id
(integer/string) (required) Widget ID.
Default: None

Return Values

(string) 
Widget description, if available. Null on failure to retrieve description.

Change Log

Since: 2.5.0

Source File

wp_widget_description() is located in wp-includes/widgets.php

Related

Widgets: is_active_widget(), the_widget(), register_widget(), unregister_widget(), wp_register_widget_control(), wp_unregister_widget_control(), wp_convert_widget_settings(), wp_get_widget_defaults(), wp_widget_description()

See also index of Function Reference and index of Template Tags.