WP_LIST_PAGES() │ WP 1.5.0

Функция wp_list_pages() возвращает или отображает список страниц (или элементов иерархического типа записи) в формате списка.

Применение функции

Эта функция используется для создания навигационного меню на сайте WordPress.

Возврат

Функция возвращает null или строку. Если аргумент echo равен true, то результат не будет возвращен, будет выведен HTML-список страниц. Если echo равен false, то вернется HTML-список страниц.

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

Основной синтаксис использования функции:

wp_list_pages( $args );

Аргументы

Аргументы можно передавать в виде массива или строки. Для подробной информации смотрите функцию get_pages().

По умолчанию: ''

• child_of (int): Показывать только подстраницы конкретной страницы по ID. По умолчанию: 0 (все страницы).
• authors (string): Список ID авторов, разделенных запятыми. По умолчанию: пусто (все авторы).
• date_format (string): Формат даты для отображения страниц. Зависят от параметра 'show_date'. По умолчанию: значение параметра 'date_format'.
• depth (int): Указывает количество уровней в иерархии страниц для включения в список. Принимает -1 (любое количество уровней), 0 (все страницы), 1 (только верхний уровень) и n (страницы до n уровней).
• echo (true|false): Указывает, нужно ли выводить список страниц. По умолчанию: true.
• exclude (string): Список ID страниц для исключения, разделенный запятыми. По умолчанию: ''.
• include (array): Список ID страниц для включения, разделенный запятыми. По умолчанию: ''.
• link_after (string): Текст или HTML, который идет после метки ссылки страницы. По умолчанию: null.
• link_before (string): Текст или HTML, который идет перед меткой ссылки страницы. По умолчанию: null.
• post_type (string): Тип записи для выборки. По умолчанию: 'page'.
• post_status (string|array): Список или массив статусов записей для включения. По умолчанию: 'publish'.
• show_date (string): Показывать дату публикации или изменения для каждой страницы. Принимает 'modified' или любое другое значение. Пустое значение скрывает дату. По умолчанию: ''.
• sort_column (string): Список имен колонок для сортировки страниц. Принимает 'post_author', 'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt', 'menu_order', 'post_parent', 'ID', 'rand' или 'comment_count'. По умолчанию: 'post_title'.
• title_li (string): Заголовок списка. Если передать null или пустое значение, заголовка не будет, и список не будет заключен в теги <ul>. По умолчанию: 'Pages'.
• item_spacing (string): Указывает сохранить пробелы в HTML меню. Принимает 'preserve' или 'discard'. По умолчанию: 'preserve'.
• walker (Walker): Экземпляр класса Walker для перечисления страниц. По умолчанию: пусто, используется экземпляр Walker_Page.

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

Пример 1: Убрать заголовок списка

Убираем заголовок списка, добавив параметр title_li:

Пример 2: Изменить заголовок

Изменяем заголовок на "Поэзия" и выводим только определенные страницы (ID 9, 5, 23):

    ' . __('Поэзия') . '' ); ?>

Пример 3: Сортировка по порядковому номеру

Сортируем список по порядковым номерам, указанным на странице редактирования "постоянных страниц":

Пример 4: Исключение страниц

Исключаем страницы с ID 17 и 38:

Пример 5: Вывод списка подстраниц

Отображаем список подстраниц текущей страницы:

ID . '&echo=0' );

if( $children ){
    ?>
    

        
    
    

Пример 6: Статический список подстраниц

Выводим статический список подстраниц, который остается при переходе на одну из дочерних страниц:

post_parent ){
    $children = wp_list_pages( "title_li=&child_of=" . $post->post_parent . "&echo=0" );
} else {
    $children = wp_list_pages( "title_li=&child_of=" . $post->ID . "&echo=0" );
}

if( $children ){
    ?>
    

        
    
    

Обратите внимание

• Используйте параметр post_type для вывода других типов записей, например:

  wp_list_pages( [
  'post_type'=>'portfolio',
  'title_li'=> __('Портфолио')
  ] );

Примечания

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