функция
since 2.5.0
wp_widget_description()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
wp_widget_description( int|string $id ): string|voidОписание
При регистрации виджетов опции могут также включать ‘description’, которое описывает виджет для отображения в панели администрирования виджетов или в теме.
Оригинал (английский)
When registering widgets, the options can also include ‘description’ that describes the widget for display on the widget administration panel or in the theme.
Параметры
$id
int|string
обязательный
ID виджета.
Возвращаемое значение
string|void
Исходный код
wp-includes/widgets.php:451
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 | Introduced. |
