add_pages_page()

Добавляет подменю к главному меню "Страницы"
Функция WordPress
INT 2.7.0
WordPress Icon

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

Функция add_pages_page() добавляет подменю в главное меню «Страницы» в административной панели WordPress.

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

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

add_pages_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ): string|false

Этот код добавляет подменю в главное меню «Страницы».

  • $page_title (string) — Обязательный. Текст, который будет отображаться в теге <title> на странице при выборе меню.
  • $menu_title (string) — Обязательный. Текст, который будет использоваться для названия меню.
  • $capability (string) — Обязательный. Требуемая возможность для отображения этого меню пользователю.
  • $menu_slug (string) — Обязательный. Идентификатор, по которому можно обратиться к этому меню (должен быть уникальным для данного меню).
  • $callback (callable) — Необязательный. Функция, которая будет вызываться для вывода содержимого на странице. По умолчанию: ».
  • $position (int) — Необязательный. Позиция элемента в порядке меню, в котором он должен появиться. По умолчанию: null.

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

<?php
/**
 * Добавляет подменю "Моя страница" в главное меню "Страницы".
 */
function my_custom_page_callback() {
    // Вывод содержимого на странице
    echo '<h1>Моя страница</h1>';
    echo '<p>Привет, это моя страница!</p>';
}
add_pages_page(
    'Моя страница',   // Текст для тега <title>
    'Моя страница',   // Текст для названия меню
    'manage_options', // Требуемая возможность
    'my-custom-page', // Идентификатор меню
    'my_custom_page_callback', // Функция обратного вызова
    10                // Позиция в меню
);
?>

В этом примере мы добавляем подменю «Моя страница» в главное меню «Страницы». Функция обратного вызова my_custom_page_callback() выводит содержимое на странице, включая заголовок и приветственное сообщение.

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

Добавление подраздела в главное меню страниц


add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug' );

В данном примере используется функция add_pages_page() для добавления подраздела в главное меню страниц. Параметры функции:

  • $page_title — текст, отображаемый в заголовке страницы при выборе меню (обязательный параметр);
  • $menu_title — текст, используемый для отображения в меню (обязательный параметр);
  • $capability — необходимая для отображения меню возможность (обязательный параметр);
  • $menu_slug — уникальное имя подраздела (обязательный параметр).

Настройка доступа к подразделу


add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug' );

В данном примере используется функция add_pages_page() для добавления подраздела в главное меню страниц. Параметр $capability определяет необходимую возможность для отображения меню. В данном случае, требуется возможность «manage_options».

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


add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug', '', 10 );

В данном примере используется функция add_pages_page() для добавления подраздела в главное меню страниц. Параметр $position определяет позицию подраздела в порядке отображения меню. В данном случае, подраздел будет отображаться на 10-ой позиции.

Вызов функции для вывода содержимого подраздела


function my_page_callback() {
    echo 'This is the content of my page.';
}
add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug', 'my_page_callback' );

В данном примере используется функция add_pages_page() для добавления подраздела в главное меню страниц. Параметр $callback определяет функцию, которая будет вызвана для вывода содержимого подраздела. В данном случае, используется функция my_page_callback(), которая выводит текст «This is the content of my page.»

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

Как добавить подменю страницы в основное меню Pages?

Для добавления подменю страницы в основное меню Pages в WordPress можно использовать функцию add_pages_page(). Эта функция позволяет добавить подменю страницы с указанными параметрами.

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


add_pages_page( 'Page Title', 'Menu Title', 'capability', 'menu_slug', 'callback', position );

В данном примере:

  • Page Title — текст, который будет отображаться в тегах title страницы при выборе меню.
  • Menu Title — текст, который будет использоваться для меню.
  • capability — необходимая для отображения меню пользовательская возможность.
  • menu_slug — уникальное имя для обращения к данному меню.
  • callback — функция, которая будет вызываться для вывода содержимого данной страницы (необязательный параметр).
  • position — позиция элемента в порядке отображения меню (необязательный параметр).

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

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

Текст, который будет отображаться в тегах title страницы при выборе меню, указывается в параметре Page Title функции add_pages_page().

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


add_pages_page( 'Page Title', 'Menu Title', 'capability', 'menu_slug', 'callback', position );

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

Текст, который будет использоваться для меню, указывается в параметре Menu Title функции add_pages_page().

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


add_pages_page( 'Page Title', 'Menu Title', 'capability', 'menu_slug', 'callback', position );

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

Для того чтобы указать необходимую возможность для отображения данного меню пользователю, необходимо использовать параметр $capability при вызове функции add_pages_page(). Этот параметр определяет, какая возможность должна быть у пользователя, чтобы увидеть данное меню. Если у пользователя нет необходимой возможности, то функция вернет значение false.


add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug', 'callback_function' );

Как указать уникальное имя (slug) для данного меню?

Уникальное имя (slug) для данного меню указывается с помощью параметра $menu_slug при вызове функции add_pages_page(). Этот slug должен быть уникальным для данного меню, чтобы не возникало конфликтов с другими элементами.


add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug', 'callback_function' );

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

Для указания функции, которая будет вызываться для вывода содержимого страницы, необходимо передать ее в качестве значения параметра $callback при вызове функции add_pages_page(). Эта функция будет вызвана при отображении страницы меню и должна содержать код для вывода необходимого контента.


function callback_function() {
    // Код для вывода содержимого страницы
}
add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug', 'callback_function' );

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

Для указания позиции данного элемента в порядке меню необходимо использовать параметр $position при вызове функции add_pages_page(). Этот параметр определяет порядковый номер, на котором должен быть расположен данный элемент в меню. Если не указать значение для этого параметра, элемент будет добавлен в конец меню.


add_pages_page( 'Page Title', 'Menu Title', 'manage_options', 'menu-slug', 'callback_function', 10 );

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

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

  • Функция add_menu_page(): Добавляет новый пункт меню в административной панели WordPress.
  • Функция add_submenu_page(): Добавляет новый подпункт меню в административной панели WordPress.
  • Функция add_action(): Регистрирует функцию, которая должна быть выполнена при определенном действии или фильтрации.
  • Функция wp_enqueue_script(): Регистрирует скрипт для последующего подключения на странице.
  • Хук admin_menu: Вызывается при создании административного меню WordPress.
  • Хук admin_enqueue_scripts: Вызывается при подключении скриптов и стилей на страницах административной панели WordPress.
  • Класс WP_Admin_Bar: Предоставляет методы для создания и управления панелью инструментов администратора.
  • Класс WP_Hook: Управляет хуками и их обработчиками в WordPress.
  • Класс WP_Screen: Предоставляет информацию о текущем экране административной панели WordPress.
Обсуждение