Документация WordPress

paginate_links

Функция paginate_links в WordPress используется для создания навигационных ссылок для постраничного перелистывания. Она часто используется на страницах архивов, таких как блоги или результаты поиска, где нужно разбить содержимое на страницы.

paginate_links( $args );

$args (массив, необязательный): Ассоциативный массив параметров для настройки вывода ссылок.

Основные параметры $args

  • base (строка): Базовый URL для страниц. По умолчанию, это значение автоматически определяется.
  • format (строка): Формат строки для номера страницы. По умолчанию: ?paged=%#%.
  • total (число): Общее количество страниц. По умолчанию — 1.
  • current (число): Номер текущей страницы. По умолчанию — 0.
  • 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 (массив): Дополнительные аргументы для URL.
  • add_fragment (строка): Дополнительный фрагмент URL (например, #content).

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

В этом примере функция paginate_links используется для создания навигации на странице архива. Аргументы base и format обеспечивают правильное формирование URL для номеров страниц.

Этот пример показывает, как добавить пользовательские тексты для ссылок «Предыдущая» и «Следующая», а также обернуть ссылки в элемент навигации с классом pagination.

Подробное объяснение

  • base: Указывает базовый URL для навигационных ссылок. str_replace используется для замены большого числа ($big) на символ подстановки (%#%), который будет заменен на номер страницы.
  • format: Определяет формат строки для номеров страниц.
  • current: Указывает текущую страницу. max( 1, get_query_var( 'paged' ) ) используется для получения текущей страницы, где paged — это переменная запроса, содержащая номер страницы.
  • total: Определяет общее количество страниц, используя свойство max_num_pages глобальной переменной $wp_query.

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

theme

Функции WordPress