wp_sidebar_description()

检索侧边栏的说明。

原型

wp_sidebar_description( string $id )

描述

注册边栏时，可以包含“description”参数，该参数描述了在窗口小部件管理面板上显示的侧边栏。

参数

$id (string) (Required) 侧边栏ID。

返回值

(string|void)  边栏说明（如果有）。

源文件

路径：wp-includes/widgets.php

<?php
...
function wp_sidebar_description( $id ) {
	if ( !is_scalar($id) )
		return;
	global $wp_registered_sidebars;
	if ( isset( $wp_registered_sidebars[ $id ]['description'] ) ) {
		return wp_kses( $wp_registered_sidebars[ $id ]['description'], 'sidebar_description' );
	}
}
...
?>

其他

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