функция
since 2.9.0
wp_sidebar_description()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
wp_sidebar_description( string $id ): string|voidОписание
При регистрации боковых панелей можно включить параметр ‘description’, который описывает боковую панель для отображения в панели администрирования виджетов.
Оригинал (английский)
When registering sidebars a ‘description’ parameter can be included that describes the sidebar for display on the widget administration panel.
Параметры
$id
string
обязательный
ID боковой панели.
Возвращаемое значение
string|void
Исходный код
wp-includes/widgets.php:476
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' );
}
}История изменений
| Версия | Описание |
|---|---|
| 2.9.0 | Introduced. |
