Функция get_admin_page_title() в WordPress с примерами.

Функция get_admin_page_title() предназначена для извлечения заголовка текущей страницы административной панели WordPress. Это полезно, когда нужно динамически использовать заголовок страницы в вашем коде или плагине.

get_admin_page_title(): string

Параметры

Функция не требует параметров.

Возвращаемое значение

Функция возвращает строку, содержащую заголовок текущей страницы админ-панели WordPress. В случае отсутствия заголовка функция вернет false.

Дополнительная информация

Функция get_admin_page_title() получает заголовок страницы из данных, которые были зарегистрированы при помощи функций add_menu_page() и add_submenu_page(). Она работает на основе глобальных переменных $menu и $submenu, которые хранят информацию о зарегистрированных страницах админ-панели. Эти данные формируются в процессе регистрации страниц через указанные функции.

Результат работы функции сохраняется в глобальной переменной $title. Однако использование этой переменной напрямую не рекомендуется, так как это может привести к неожиданным результатам. Рекомендуется использовать get_admin_page_title() для получения заголовка текущей страницы.

Пример 1: Получение заголовка страницы-подменю в пункте меню «Инструменты»

В этом примере мы создадим подменю в административной панели, используя add_submenu_page(), и динамически отобразим заголовок этой страницы с помощью get_admin_page_title().

<?php
// Добавляем страницу-подменю в меню админ-панели "Инструменты"
add_action('admin_menu', function() {
    add_submenu_page(
        'tools.php', // Родительская страница
        'Страница моих инструментов', // Заголовок страницы
        'Мои инструменты', // Название подменю
        'edit_others_posts', // Права доступа
        'my_tools', // Уникальное название страницы
        'my_tools_submenu_page_callback' // Функция для отображения содержимого
    );
});

function my_tools_submenu_page_callback() {
    ?>
    <div class="wrap">
        <h2><?php echo esc_html(get_admin_page_title()); ?></h2>
        <p>Контент страницы здесь.</p>
    </div>
    <?php
}

В этом примере функция my_tools_submenu_page_callback() используется для вывода заголовка страницы подменю в административной панели. Заголовок страницы отображается с помощью get_admin_page_title() внутри элемента HTML <h2>.

Пример 2: Динамическое использование заголовка для настроек плагина

Если вы хотите использовать заголовок страницы для настройки плагина или создания динамического интерфейса, используйте get_admin_page_title() следующим образом:

<?php
function my_plugin_settings_page() {
    // Получаем заголовок страницы
    $page_title = get_admin_page_title();
    
    // Отображаем заголовок на странице настроек
    ?>
    <div class="wrap">
        <h1><?php echo esc_html($page_title); ?></h1>
        <form method="post" action="options.php">
            <?php
            settings_fields('my_plugin_options_group');
            do_settings_sections('my-plugin-settings');
            submit_button();
            ?>
        </form>
    </div>
    <?php
}

// Добавляем страницу настроек
add_action('admin_menu', function() {
    add_options_page('Настройки Моего Плагина', 'Мой Плагин', 'manage_options', 'my-plugin-settings', 'my_plugin_settings_page');
});

В этом примере функция my_plugin_settings_page() создает страницу настроек для плагина и использует get_admin_page_title() для отображения заголовка страницы в административной панели.

Заключение

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