1. 首页
  2. WordPress 函数手册

wp_widget_description()

wp_widget_description( int|string $id )

检索小部件的描述。
Retrieve description for widget.

目录锚点:#说明#参数#源码


说明(Description)

当注册小部件时,选项还可以包括“描述”,描述要在小部件管理面板或主题中显示的小部件。


参数(Parameters)

参数 类型 说明
$id (int | string) 小工具.ID。

源码(Source)

/**
 * 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.
 *
 * @since 2.5.0
 *
 * @global array $wp_registered_widgets
 *
 * @param int|string $id Widget ID.
 * @return string|void Widget description, if available.
 */
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'] );
}
更新版本 源码位置 使用 被使用
2.5.0 wp-includes/widgets.php 15 15

wp_widget_description() 为WP2原创文章,链接:https://www.wp2.cn/functions/wp_widget_description/