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

Содержание

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

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

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

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

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

get_the_posts_pagination( array $args = array() ): string

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

$args = array(
    'prev_text'          => __( '« Previous', 'textdomain' ),
    'next_text'          => __( 'Next »', 'textdomain' ),
    'screen_reader_text' => __( 'Posts navigation', 'textdomain' ),
);
echo get_the_posts_pagination( $args );

В данном примере мы создаем массив $args с настройками пагинации и выводим разметку пагинации с помощью функции get_the_posts_pagination().

$args (массив, необязательный) — Аргументы пагинации, см. функцию paginate_links().
screen_reader_text (строка) — Текст для считывания экраном для элемента навигации. По умолчанию: ‘Posts navigation’.
aria_label (строка) — Текст для атрибута aria-label для элемента nav. По умолчанию: ‘Posts’.
class (строка) — Пользовательский класс для элемента nav. По умолчанию: ‘pagination’.
Дополнительные аргументы из paginate_links(... $args) — Массив или строка аргументов для генерации пагинированных ссылок для архивов.

Функция возвращает разметку для ссылок пагинации в виде строки.

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

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

Получение пагинации для списка постов


$args = array(
    'prev_text' => '« Previous',
    'next_text' => 'Next »',
);
$pagination = get_the_posts_pagination( $args );
echo $pagination;

В данном примере мы используем функцию get_the_posts_pagination() для получения пагинации для списка постов. Мы передаем массив $args с настройками пагинации, в котором указываем текст для ссылок «Previous» и «Next». Затем мы выводим полученную пагинацию с помощью функции echo.

Настройка текста для навигации постов


$args = array(
    'prev_text' => '« Previous',
    'next_text' => 'Next »',
);
$pagination = get_the_posts_pagination( $args );
echo $pagination;

Изменение класса для элемента навигации


$args = array(
    'class' => 'custom-pagination',
);
$pagination = get_the_posts_pagination( $args );
echo $pagination;

В данном примере мы используем функцию get_the_posts_pagination() для получения пагинации для списка постов. Мы передаем массив $args с настройками пагинации, в котором указываем класс «custom-pagination» для элемента навигации. Затем мы выводим полученную пагинацию с помощью функции echo.

Настройка ARIA-атрибутов для навигации


$args = array(
    'aria_label' => 'Custom label',
);
$pagination = get_the_posts_pagination( $args );
echo $pagination;

В данном примере мы используем функцию get_the_posts_pagination() для получения пагинации для списка постов. Мы передаем массив $args с настройками пагинации, в котором указываем ARIA-атрибут «Custom label» для элемента навигации. Затем мы выводим полученную пагинацию с помощью функции echo.

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


$args = array(
    'format' => 'page %#%',
);
$pagination = get_the_posts_pagination( $args );
echo $pagination;

В данном примере мы используем функцию get_the_posts_pagination() для получения пагинации для списка постов. Мы передаем массив $args с настройками пагинации, в котором указываем формат «page %#%» для структуры пагинации. Затем мы выводим полученную пагинацию с помощью функции echo.

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

Как изменить текст навигации для функции get_the_posts_pagination()?

Для изменения текста навигации в функции get_the_posts_pagination() необходимо использовать аргументы функции paginate_links().


$args = array(
    'prev_text' => 'Custom Previous',
    'next_text' => 'Custom Next',
);
echo get_the_posts_pagination($args);

Как изменить класс для элемента навигации в функции get_the_posts_pagination()?

Для изменения класса элемента навигации в функции get_the_posts_pagination() необходимо использовать аргумент ‘class’ функции paginate_links().


$args = array(
    'class' => 'custom-pagination',
);
echo get_the_posts_pagination($args);

Как изменить ARIA-метку для элемента навигации в функции get_the_posts_pagination()?

Для изменения ARIA-метки элемента навигации в функции get_the_posts_pagination() необходимо использовать аргумент ‘aria_label’ функции paginate_links().


$args = array(
    'aria_label' => 'Custom ARIA Label',
);
echo get_the_posts_pagination($args);

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

Функция get_the_posts_pagination() позволяет изменить формат структуры пагинации с помощью аргумента format. По умолчанию значение этого аргумента равно 'page/%#%/', что означает, что пагинация будет иметь вид example.com/page/2/.

Чтобы изменить формат структуры пагинации, нужно передать новое значение аргументу format. Например, чтобы изменить формат на '?paged=%#%', нужно использовать следующий код:


$args = array(
    'format' => '?paged=%#%',
);
echo get_the_posts_pagination( $args );

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

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

Чтобы изменить общее количество страниц, нужно передать новое значение аргументу total. Например, чтобы указать, что общее количество страниц равно 10, нужно использовать следующий код:


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

Как изменить текущую страницу в функции get_the_posts_pagination()?

Функция get_the_posts_pagination() автоматически определяет текущую страницу на основе значения аргумента current. По умолчанию, если значение current не указано, функция использует значение переменной 'paged' или 1, если значение переменной 'paged' не определено.

Чтобы изменить текущую страницу, нужно передать новое значение аргументу current. Например, чтобы указать, что текущая страница равна 3, нужно использовать следующий код:


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

Как изменить количество отображаемых страниц в функции get_the_posts_pagination()?

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


$args = array(
    'mid_size' => 3
);
get_the_posts_pagination($args);

Как скрыть предыдущую и следующую ссылки в функции get_the_posts_pagination()?

Для скрытия предыдущей и следующей ссылок в функции get_the_posts_pagination() можно использовать параметр ‘prev_next’. По умолчанию значение этого параметра равно true, что означает, что ссылки будут отображаться. Чтобы скрыть ссылки, нужно задать значение false для ‘prev_next’.


$args = array(
    'prev_next' => false
);
get_the_posts_pagination($args);

Как изменить текст предыдущей и следующей ссылок в функции get_the_posts_pagination()?

Для изменения текста предыдущей и следующей ссылок в функции get_the_posts_pagination() можно использовать параметры ‘prev_text’ и ‘next_text’. По умолчанию значение ‘prev_text’ равно ‘« Previous’ и ‘next_text’ равно ‘Next »’. Чтобы изменить текст ссылок, нужно задать другие значения для ‘prev_text’ и ‘next_text’.


$args = array(
    'prev_text' => 'Previous page',
    'next_text' => 'Next page'
);
get_the_posts_pagination($args);

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

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

Функция the_posts_pagination(): выводит разметку для пагинации постов.
Функция paginate_links(): генерирует пагинацию со ссылками.
Класс WP_Query: основной класс для работы с запросами к базе данных WordPress.
Класс WP_Post: представляет отдельный пост в WordPress.
Класс WP_Posts_List_Table: класс для отображения списка постов в административной панели WordPress.