paginate_links()

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

Генерация пагинации для архивных страниц

$args = array(
    'base' => '%_%',
    'format' => '?paged=%#%',
    'total' => 10,
    'current' => 1,
    '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' => ''
);
echo paginate_links($args);

В этом примере мы создаем пагинацию для архивных страниц с общим количеством страниц равным 10. Текущая страница установлена на 1. Мы не показываем все страницы, а только некоторое количество. В начале и в конце списка отображается по одной ссылке, а по бокам от текущей страницы — по две ссылки. Также включены предыдущая и следующая ссылки.

Создание ссылок на страницы архива

$args = array(
    'base' => '%_%',
    'format' => '?paged=%#%',
    'total' => 10,
    'current' => 1,
    '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' => ''
);
$pagination = paginate_links($args);
if ($pagination) {
    echo '<div class="pagination">' . $pagination . '</div>';
}

В этом примере мы создаем пагинацию для архивных страниц и сохраняем результат в переменную $pagination. Затем мы проверяем, есть ли пагинация, и если есть, выводим ее в блок div с классом «pagination».

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

$args = array(
    'base' => '%_%',
    'format' => '?paged=%#%',
    'total' => 10,
    'current' => 1,
    'show_all' => false,
    'end_size' => 1,
    'mid_size' => 2,
    'prev_next' => true,
    'prev_text' => __('« Previous'),
    'next_text' => __('Next »'),
    'type' => 'list',
    'add_args' => false,
    'add_fragment' => '',
    'before_page_number' => '',
    'after_page_number' => ''
);
echo paginate_links($args);

В этом примере мы настраиваем формат пагинации на список (type = ‘list’). Результат будет выглядеть как неупорядоченный список ul/li.

Отображение всех страниц

$args = array(
    'base' => '%_%',
    'format' => '?paged=%#%',
    'total' => 10,
    'current' => 1,
    'show_all' => true,
    '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' => ''
);
echo paginate_links($args);

В этом примере мы устанавливаем параметр show_all в true, чтобы показать все страницы пагинации, а не только некоторое количество.

Добавление предыдущей и следующей ссылок

$args = array(
    'base' => '%_%',
    'format' => '?paged=%#%',
    'total' => 10,
    'current' => 1,
    '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' => ''
);
echo paginate_links($args);

В этом примере мы включаем предыдущую и следующую ссылки в пагинацию.

Изменение текста ссылок

$args = array(
    'base' => '%_%',
    'format' => '?paged=%#%',
    'total' => 10,
    'current' => 1,
    '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' => ''
);
echo paginate_links($args);

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

Форматирование возвращаемого значения

$args = array(
    'base' => '%_%',
    'format' => '?paged=%#%',
    'total' => 10,
    'current' => 1,
    'show_all' => false,
    'end_size' => 1,
    'mid_size' => 2,
    'prev_next' => true,
    'prev_text' => __('« Previous'),
    'next_text' => __('Next »'),
    'type' => 'array',
    'add_args' => false,
    'add_fragment' => '',
    'before_page_number' => '',
    'after_page_number' => ''
);
$pagination = paginate_links($args);
if ($pagination) {
    foreach ($pagination as $link) {
        echo '<span class="page-link">' . $link . '</span>';
    }
}

В этом примере мы настраиваем формат возвращаемого значения на массив (type = ‘array’). Затем мы проходимся по каждой ссылке в массиве и выводим ее внутри элемента span с классом «page-link».