wp_sidebar_description

函数


wp_sidebar_description ( $id )
参数
  • (string)
    $id
    sidebar ID.
    Required:
返回值
  • (string|void) Sidebar description, if available.
定义位置
  • wp-includes/widgets.php
    , line 466
引入
2.9.0
弃用

Retrieve description for a sidebar.

When registering sidebars a ‘description’ parameter can be included that
describes the sidebar for display on the widget administration panel.

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