wp_widget_description

函数


wp_widget_description ( $id )
参数
  • (int|string)
    $id
    Widget ID.
    Required: 是
返回值
  • (string|void) Widget description, if available.
定义位置
  • wp-includes/widgets.php
    , line 441
引入
2.5.0
弃用
–

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.

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