Функция wp_add_dashboard_widget() - WordPres Коды и Элементы

Содержание

Описание функции
Примеры использования
Добавление виджета на панель управления
Настройка виджета на панели управления
Установка контекста отображения виджета на панели управления
Установка приоритета отображения виджета на панели управления
Передача дополнительных аргументов в виджет на панели управления
Вопросы и ответы
Как изменить порядок отображения виджетов на панели управления?
Как удалить виджет с панели управления?
Как изменить контекст и приоритет виджета на панели управления?
Как добавить элементы управления (кнопки, поля ввода и т. д.) в виджет на панели управления?
Как изменить заголовок виджета на панели управления?
Как создать виджет, который будет отображаться только на определенных страницах административной панели?
Как добавить виджет на панель управления с боковой панелью?
Как изменить размер виджета на панели управления?
Связанные элементы

Описание функции

Функция wp_add_dashboard_widget() добавляет новый виджет на панель управления WordPress.

Виджеты на панели управления представляют собой блоки, которые отображаются на главной странице административной панели. Они могут содержать различную информацию, такую как статистику, уведомления, календари и другие пользовательские данные.

Функция wp_add_dashboard_widget() позволяет создавать и настраивать виджеты на панели управления. Она принимает несколько параметров, включая идентификатор виджета, название виджета, функцию заполнения виджета контентом и другие параметры.

Использование

wp_add_dashboard_widget( string $widget_id, string $widget_name, callable $callback, callable $control_callback = null, array $callback_args = null, string $context = 'normal', string $priority = 'core' )

Пример использования функции wp_add_dashboard_widget():

$widget_id (строка) — Обязательный. Идентификатор виджета (используется в атрибуте ‘id’ для виджета).
$widget_name (строка) — Обязательный. Заголовок виджета.
$callback (callable) — Обязательный. Функция, которая заполняет виджет нужным контентом. Функция должна выводить свой результат с помощью echo.
$control_callback (callable) — Необязательный. Функция, которая выводит элементы управления для виджета. По умолчанию: null.
$callback_args (массив) — Необязательный. Данные, которые должны быть установлены в свойство $args виджета (второй параметр, передаваемый в вашу функцию обратного вызова). По умолчанию: null.
$context (строка) — Необязательный. Контекст на экране, где должен отображаться виджет. Принимает значения ‘normal’, ‘side’, ‘column3’ или ‘column4’. По умолчанию: ‘normal’.
$priority (строка) — Необязательный. Приоритет в контексте, где должен отображаться виджет. Принимает значения ‘high’, ‘core’, ‘default’ или ‘low’. По умолчанию: ‘core’.

<?php
/**
 * Пример создания виджета на панели управления WordPress.
 *
 * @param string $widget_id Идентификатор виджета.
 * @param string $widget_name Заголовок виджета.
 * @param callable $callback Функция заполнения виджета контентом.
 * @param callable $control_callback Функция вывода элементов управления для виджета.
 * @param array $callback_args Данные для передачи в функцию обратного вызова.
 * @param string $context Контекст отображения виджета.
 * @param string $priority Приоритет отображения виджета.
 */
function custom_dashboard_widget( $widget_id, $widget_name, $callback, $control_callback = null, $callback_args = null, $context = 'normal', $priority = 'core' ) {
    // Создаем виджет на панели управления
    wp_add_dashboard_widget( $widget_id, $widget_name, $callback, $control_callback, $callback_args, $context, $priority );
}
// Пример использования функции
custom_dashboard_widget(
    'custom_widget_id',
    'Мой виджет',
    'custom_widget_callback',
    'custom_widget_control_callback',
    array( 'param1' => 'value1', 'param2' => 'value2' ),
    'normal',
    'core'
);
/**
 * Функция заполнения виджета контентом.
 */
function custom_widget_callback() {
    // Выводим контент виджета
    echo 'Содержимое виджета';
}
/**
 * Функция вывода элементов управления для виджета.
 */
function custom_widget_control_callback() {
    // Выводим элементы управления для виджета
    echo 'Элементы управления виджета';
}
?>

Примеры использования

Добавление виджета на панель управления


/**
 * Добавляет виджет на панель управления.
 *
 * @param string   $widget_id         Идентификатор виджета (используется в атрибуте 'id' для виджета).
 * @param string   $widget_name       Заголовок виджета.
 * @param callable $callback          Функция, которая заполняет виджет нужным содержимым.
 *                                    Функция должна выводить свой результат.
 * @param callable $control_callback Функция, которая выводит элементы управления для виджета.
 *                                    По умолчанию: null.
 * @param array    $callback_args     Данные, которые должны быть установлены в свойство $args виджета.
 *                                    По умолчанию: null.
 * @param string   $context           Контекст отображения виджета на панели управления.
 *                                    Принимает значения 'normal', 'side', 'column3' или 'column4'.
 *                                    По умолчанию: 'normal'.
 * @param string   $priority          Приоритет отображения виджета на панели управления.
 *                                    Принимает значения 'high', 'core', 'default' или 'low'.
 *                                    По умолчанию: 'core'.
 */
wp_add_dashboard_widget( $widget_id, $widget_name, $callback, $control_callback, $callback_args, $context, $priority );

Настройка виджета на панели управления


/**
 * Пример настройки виджета на панели управления.
 */
function my_dashboard_widget_content() {
    // Выводим содержимое виджета
    echo 'Привет, я виджет на панели управления!';
}
// Добавляем виджет на панель управления
wp_add_dashboard_widget( 'my_dashboard_widget', 'Мой виджет', 'my_dashboard_widget_content' );

Установка контекста отображения виджета на панели управления


/**
 * Пример установки контекста отображения виджета на панели управления.
 */
function my_dashboard_widget_content() {
    // Выводим содержимое виджета
    echo 'Привет, я виджет на панели управления!';
}
// Добавляем виджет на панель управления с контекстом 'side'
wp_add_dashboard_widget( 'my_dashboard_widget', 'Мой виджет', 'my_dashboard_widget_content', null, null, 'side' );

Установка приоритета отображения виджета на панели управления


/**
 * Пример установки приоритета отображения виджета на панели управления.
 */
function my_dashboard_widget_content() {
    // Выводим содержимое виджета
    echo 'Привет, я виджет на панели управления!';
}
// Добавляем виджет на панель управления с приоритетом 'high'
wp_add_dashboard_widget( 'my_dashboard_widget', 'Мой виджет', 'my_dashboard_widget_content', null, null, 'normal', 'high' );

Передача дополнительных аргументов в виджет на панели управления


/**
 * Пример передачи дополнительных аргументов в виджет на панели управления.
 */
function my_dashboard_widget_content( $args ) {
    // Выводим содержимое виджета
    echo 'Привет, я виджет на панели управления!';
    echo 'Дополнительные аргументы: ' . $args['my_custom_arg'];
}
// Добавляем виджет на панель управления с дополнительными аргументами
wp_add_dashboard_widget( 'my_dashboard_widget', 'Мой виджет', 'my_dashboard_widget_content', null, array( 'my_custom_arg' => 'Значение аргумента' ) );

Вопросы и ответы

Как изменить порядок отображения виджетов на панели управления?

Для изменения порядка отображения виджетов на панели управления в WordPress можно использовать функцию wp_add_dashboard_widget(). Параметр $priority позволяет указать приоритет виджета, определяющий его положение относительно других виджетов.

Пример кода:


function custom_dashboard_widgets_order() {
    // Добавляем виджеты с разными приоритетами
    wp_add_dashboard_widget( 'widget1', 'Widget 1', 'widget1_callback', null, null, 'normal', 'high' );
    wp_add_dashboard_widget( 'widget2', 'Widget 2', 'widget2_callback', null, null, 'normal', 'core' );
    wp_add_dashboard_widget( 'widget3', 'Widget 3', 'widget3_callback', null, null, 'normal', 'low' );
}
add_action( 'wp_dashboard_setup', 'custom_dashboard_widgets_order' );

Как удалить виджет с панели управления?

Для удаления виджета с панели управления в WordPress используется функция remove_meta_box(). Параметр $id задает идентификатор виджета, который нужно удалить.

Пример кода:


function remove_dashboard_widget() {
    // Удаляем виджет с идентификатором 'widget1'
    remove_meta_box( 'widget1', 'dashboard', 'normal' );
}
add_action( 'wp_dashboard_setup', 'remove_dashboard_widget' );

Как изменить контекст и приоритет виджета на панели управления?

Для изменения контекста и приоритета виджета на панели управления в WordPress можно использовать функцию wp_add_dashboard_widget(). Параметры $context и $priority позволяют задать соответственно контекст и приоритет виджета.

Пример кода:


function custom_dashboard_widget_context() {
    // Добавляем виджет с контекстом 'side' и приоритетом 'high'
    wp_add_dashboard_widget( 'widget1', 'Widget 1', 'widget1_callback', null, null, 'side', 'high' );
}
add_action( 'wp_dashboard_setup', 'custom_dashboard_widget_context' );

Как добавить элементы управления (кнопки, поля ввода и т. д.) в виджет на панели управления?

Для добавления элементов управления в виджет на панели управления в WordPress можно использовать функцию wp_add_dashboard_widget(). Параметр $control_callback позволяет указать функцию, которая будет выводить элементы управления для виджета.

Пример кода:


function custom_dashboard_widget_controls() {
    // Добавляем виджет с элементами управления
    wp_add_dashboard_widget( 'widget1', 'Widget 1', 'widget1_callback', 'widget1_control_callback' );
}
function widget1_control_callback() {
    // Выводим элементы управления для виджета
    echo '<p>Элементы управления виджета</p>';
    echo '<button>Кнопка</button>';
    echo '<input type="text" name="input_field" value="">';
}
add_action( 'wp_dashboard_setup', 'custom_dashboard_widget_controls' );

Как изменить заголовок виджета на панели управления?

Для изменения заголовка виджета на панели управления используется параметр $widget_name функции wp_add_dashboard_widget(). Этот параметр принимает строку с новым заголовком виджета.


function custom_dashboard_widget_content() {
    // Ваш код для заполнения виджета контентом
}
wp_add_dashboard_widget( 'custom_dashboard_widget', 'Новый заголовок виджета', 'custom_dashboard_widget_content' );

Как создать виджет, который будет отображаться только на определенных страницах административной панели?

Для создания виджета, который будет отображаться только на определенных страницах административной панели, используется параметр $context функции wp_add_dashboard_widget(). Этот параметр принимает одно из значений: ‘normal’, ‘side’, ‘column3’ или ‘column4’.


function custom_dashboard_widget_content() {
    // Ваш код для заполнения виджета контентом
}
wp_add_dashboard_widget( 'custom_dashboard_widget', 'Заголовок виджета', 'custom_dashboard_widget_content', null, null, 'side' );

Как добавить виджет на панель управления с боковой панелью?

Для добавления виджета на панель управления с боковой панелью используется параметр $context функции wp_add_dashboard_widget(). Этот параметр принимает значение ‘side’.


function custom_dashboard_widget_content() {
    // Ваш код для заполнения виджета контентом
}
wp_add_dashboard_widget( 'custom_dashboard_widget', 'Заголовок виджета', 'custom_dashboard_widget_content', null, null, 'side' );

Как изменить размер виджета на панели управления?

Изменение размера виджета на панели управления не предусмотрено в функции wp_add_dashboard_widget(). Размер виджета определяется автоматически в зависимости от контента, который вы выводите в виджете.

Функция wp_add_dashboard_widget() позволяет добавлять новые виджеты на панель управления WordPress. С помощью параметров функции можно настроить заголовок виджета, контент, контекст отображения и приоритет виджета. Это полезная функция для создания пользовательских виджетов и настройки панели управления под свои нужды.

Связанные элементы

Хук wp_dashboard_setup: Позволяет добавить виджеты на панель управления.
Хук wp_dashboard_widgets: Позволяет изменить список виджетов на панели управления.
Хук wp_network_dashboard_setup: Позволяет добавить виджеты на панель управления сети сайтов.
Класс WP_Widget: Базовый класс для создания виджетов.
Класс WP_Screen: Предоставляет информацию о текущем экране.