检索小部件的描述。

原型

wp_widget_description( int|string $id )

描述

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

参数

$id (int|string) (Required) 小部件ID。

返回值

(string|void)  窗口小部件描述(如果有)。

源文件

路径:wp-includes/widgets.php

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

其他

英文文档:https://developer.wordpress.org/reference/functions/wp_widget_description/