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

Содержание

Описание функции
Примеры использования
Отображение навигации по страницам
Подключение функции the_posts_pagination()
Настройка параметров пагинации
Изменение формата пагинации
Добавление дополнительных аргументов
Изменение текста ссылок на предыдущую и следующую страницы
Вопросы и ответы
Как изменить формат структуры пагинации?
Как указать базу для пагинированного URL?
Как изменить общее количество страниц?
Как изменить текущий номер страницы?
Как изменить значение атрибута aria-current?
Как показать все страницы пагинации?
Как изменить количество чисел в начале и конце списка?
Как изменить количество чисел по бокам текущей страницы?
Как изменить текст ссылки на предыдущую страницу?
Как изменить текст ссылки на следующую страницу?
Связанные элементы

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

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

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

the_posts_pagination( array $args = array() )

Функция the_posts_pagination() принимает один необязательный аргумент — массив $args, который содержит параметры для генерации ссылок пагинации.

base (строка): Базовый URL для пагинированных ссылок.
format (строка): Формат структуры пагинации.
total (число): Общее количество страниц. По умолчанию используется значение max_num_pages из объекта WP_Query или 1.
current (число): Текущий номер страницы. По умолчанию используется значение переменной 'paged' или 1.
aria_current (строка): Значение атрибута aria-current. Возможные значения: 'page', 'step', 'location', 'date', 'time', 'true', 'false'. По умолчанию используется 'page'.
show_all (логическое): Определяет, нужно ли показывать все страницы. По умолчанию false.
end_size (число): Количество номеров страниц в начале и конце списка. По умолчанию 1.
mid_size (число): Количество номеров страниц вокруг текущей страницы. По умолчанию 2.
prev_next (логическое): Определяет, нужно ли включать ссылки на предыдущую и следующую страницы в списке. По умолчанию true.
prev_text (строка): Текст ссылки на предыдущую страницу. По умолчанию '« Previous'.
next_text (строка): Текст ссылки на следующую страницу. По умолчанию 'Next »'.
type (строка): Определяет формат возвращаемого значения. Возможные значения: 'plain', 'array', 'list'. По умолчанию 'plain'.
add_args (массив): Массив аргументов запроса для добавления. По умолчанию false.
add_fragment (строка): Строка, добавляемая к каждой ссылке. По умолчанию ''.
before_page_number (строка): Строка, отображаемая перед номером страницы. По умолчанию ''.
after_page_number (строка): Строка, добавляемая после номера страницы. По умолчанию ''.

<?php
$args = array(
  'base' => '%_%',
  'format' => '?paged=%#%',
  'total' => 10,
  'current' => 1,
  'aria_current' => 'page',
  'show_all' => false,
  'end_size' => 1,
  'mid_size' => 2,
  'prev_next' => true,
  'prev_text' => '« Previous',
  'next_text' => 'Next »',
  'type' => 'plain',
  'add_args' => false,
  'add_fragment' => '',
  'before_page_number' => '',
  'after_page_number' => ''
);
the_posts_pagination( $args );
?>

В этом примере мы создаем массив $args со всеми доступными параметрами функции the_posts_pagination(). Затем мы вызываем функцию и передаем ей этот массив в качестве аргумента. В результате будет отображена пагинация с заданными параметрами.

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

Отображение навигации по страницам

<?php
    the_posts_pagination();
?>

Этот пример кода отображает навигацию по страницам для набора постов. Функция the_posts_pagination() автоматически определяет, когда навигация по страницам необходима, и отображает ссылки на предыдущую и следующую страницы.

Подключение функции the_posts_pagination()

<?php
    if ( function_exists( 'the_posts_pagination' ) ) {
        the_posts_pagination();
    }
?>

Этот пример кода проверяет, существует ли функция the_posts_pagination() в текущей версии WordPress, и если она существует, то отображает навигацию по страницам.

Настройка параметров пагинации

<?php
    $args = array(
        'prev_text' => 'Previous',
        'next_text' => 'Next',
        'show_all' => true,
    );
    the_posts_pagination( $args );
?>

Этот пример кода позволяет настроить параметры пагинации. В данном случае, текст ссылок на предыдущую и следующую страницы изменяется на «Previous» и «Next», а также отображаются все страницы.

Изменение формата пагинации

<?php
    $args = array(
        'format' => 'page %#%',
    );
    the_posts_pagination( $args );
?>

Этот пример кода изменяет формат пагинации на «page %#%», где %#% заменяется на номер текущей страницы.

Добавление дополнительных аргументов

<?php
    $args = array(
        'add_args' => array(
            'custom_arg' => 'value',
        ),
    );
    the_posts_pagination( $args );
?>

Этот пример кода добавляет дополнительные аргументы к ссылкам пагинации. В данном случае, добавляется аргумент «custom_arg» со значением «value».

Изменение текста ссылок на предыдущую и следующую страницы

<?php
    $args = array(
        'prev_text' => '« Previous',
        'next_text' => 'Next »',
    );
    the_posts_pagination( $args );
?>

Этот пример кода изменяет текст ссылок на предыдущую и следующую страницы на «« Previous» и «Next »».

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

Как изменить формат структуры пагинации?

Функция the_posts_pagination() позволяет изменить формат структуры пагинации с помощью параметра format. По умолчанию формат установлен в значение 'paginate_links'. Чтобы изменить формат, необходимо передать новое значение в параметр format.


$args = array(
    'format' => 'custom_format',
);
the_posts_pagination( $args );

Как указать базу для пагинированного URL?

Функция the_posts_pagination() позволяет указать базу для пагинированного URL с помощью параметра base. По умолчанию база установлена в значение '%_%'. Чтобы указать свою базу, необходимо передать новое значение в параметр base.


$args = array(
    'base' => 'http://example.com/%_%',
);
the_posts_pagination( $args );

Как изменить общее количество страниц?

Функция the_posts_pagination() автоматически определяет общее количество страниц на основе значения параметра total. По умолчанию общее количество страниц равно значению max_num_pages из объекта WP_Query или 1, если значение max_num_pages не установлено.

Чтобы изменить общее количество страниц, необходимо передать новое значение в параметр total.


$args = array(
    'total' => 10,
);
the_posts_pagination( $args );

Как изменить текущий номер страницы?

Для изменения текущего номера страницы в функции the_posts_pagination() необходимо использовать параметр current. По умолчанию, значение параметра равно значению переменной 'paged' или 1. Чтобы изменить текущий номер страницы, нужно передать новое значение в параметр current.


$args = array(
    'current' => 3,
);
the_posts_pagination( $args );

Как изменить значение атрибута aria-current?

Значение атрибута aria-current в функции the_posts_pagination() можно изменить с помощью параметра aria_current. По умолчанию, значение параметра равно 'page'. Чтобы изменить значение атрибута, нужно передать новое значение в параметр aria_current.


$args = array(
    'aria_current' => 'step',
);
the_posts_pagination( $args );

Как показать все страницы пагинации?

Чтобы показать все страницы пагинации в функции the_posts_pagination(), нужно установить параметр show_all в значение true. По умолчанию, значение параметра равно false.


$args = array(
    'show_all' => true,
);
the_posts_pagination( $args );

Как изменить количество чисел в начале и конце списка?

Для изменения количества чисел в начале и конце списка используется параметр end_size. По умолчанию этот параметр равен 1. Чтобы изменить количество чисел, необходимо передать новое значение в функцию the_posts_pagination().


$args = array(
    'end_size' => 3
);
the_posts_pagination( $args );

Как изменить количество чисел по бокам текущей страницы?

Для изменения количества чисел по бокам текущей страницы используется параметр mid_size. По умолчанию этот параметр равен 2. Чтобы изменить количество чисел, необходимо передать новое значение в функцию the_posts_pagination().


$args = array(
    'mid_size' => 4
);
the_posts_pagination( $args );

Как изменить текст ссылки на предыдущую страницу?

Для изменения текста ссылки на предыдущую страницу используется параметр prev_text. По умолчанию этот параметр равен ‘« Previous’. Чтобы изменить текст, необходимо передать новое значение в функцию the_posts_pagination().


$args = array(
    'prev_text' => 'Previous Page'
);
the_posts_pagination( $args );

Как изменить текст ссылки на следующую страницу?

Для изменения текста ссылки на следующую страницу используется параметр next_text. По умолчанию этот параметр равен ‘Next »’. Чтобы изменить текст, необходимо передать новое значение в функцию the_posts_pagination().


$args = array(
    'next_text' => 'Next Page'
);
the_posts_pagination( $args );

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

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

Функция get_the_posts_pagination(): Возвращает пагинацию для набора записей.
Функция paginate_links(): Генерирует пагинацию для набора ссылок.
Функция get_pagenum_link(): Возвращает URL для указанной страницы пагинации.
Функция get_previous_posts_link(): Возвращает ссылку на предыдущую страницу записей.
Функция get_next_posts_link(): Возвращает ссылку на следующую страницу записей.
Функция get_the_posts_navigation(): Возвращает навигацию для набора записей.
Функция the_posts_navigation(): Выводит навигацию для набора записей.
Хук previous_posts_link_attributes: Позволяет изменить атрибуты ссылки на предыдущую страницу записей.
Хук next_posts_link_attributes: Позволяет изменить атрибуты ссылки на следующую страницу записей.