Функция add_theme_page() в WordPress

Функция add_theme_page() позволяет добавить подменю в главное меню "Внешний вид" (Appearance) вашего WordPress сайта. Это полезно, если вы хотите создать страницу для настройки тем.

Как это работает?

Эта функция принимает специальные права (capabilities), чтобы определить, сможет ли пользователь увидеть это подменю. Также функция, которая отвечает за вывод страницы, должна проверять, есть ли у пользователя необходимые права.

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

Функция возвращает строку с идентификатором подменю или false, если у пользователя нет необходимых прав для его отображения.

Синтаксис использования

add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $callback, $position );

• $page_title (string, требуется): Название, которое будет отображаться в заголовках страницы, когда меню выбрано.
• $menu_title (string, требуется): Название, которое будет использоваться в меню.
• $capability (string, требуется): Права, необходимые для отображения данного меню пользователю.
• $menu_slug (string, требуется): Уникальное имя для этого меню.
• $callback (callable): Функция, которая будет вызываться для вывода содержимого этой страницы. По умолчанию: ''.
• $position (int): Позиция в порядке меню, где этот элемент должен отображаться. По умолчанию: null.

Пример

Рассмотрим, как создать элемент в меню "Внешний вид":

function my_appearance_menu_item() {
    add_theme_page(
        'Настройки темы', // $page_title
        'Настройки',      // $menu_title
        'edit_theme_options', // $capability
        'my-unique-identifier', // $menu_slug
        'my_plugin_function'    // $callback
    );
}
add_action('admin_menu', 'my_appearance_menu_item');

function my_plugin_function() {
    echo "Текст на странице настроек.";
}

Пояснение примера:

• Функция my_appearance_menu_item() добавляет новое подменю в меню "Внешний вид".
• В качестве заголовка страницы используется "Настройки темы", а в качестве названия меню — "Настройки".
• Пользователь должен иметь права edit_theme_options, чтобы увидеть этот элемент.
• Функция my_plugin_function() отвечает за вывод текста "Текст на странице настроек." на создаваемой странице.

Изменения в версиях WordPress

• С версии 2.0.0: Функция была введена.
• С версии 5.3.0: Добавлен параметр $position.

Код функции add_theme_page()

Вот как выглядит код функции add_theme_page() в WordPress:

function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position );
}

Связанные функции

• add_menu_page(): Создает элемент в главном меню.
• add_options_page(): Добавляет страницу настроек.
• add_submenu_page(): Добавляет подменю к существующему меню.
• remove_menu_page(): Удаляет элемент из главного меню.
• remove_submenu_page(): Удаляет подменю из меню.

Заключение

Функция add_theme_page() — это полезный инструмент для разработчиков WordPress, позволяющий легко настраивать и добавлять новые страницы в админ-панели. С ее помощью вы можете расширить функциональность своего сайта, добавив удобные интерфейсы для управления вашими темами.