Функция paginate_comments_links() в WordPress с примерами.

Главная - WordPress Codex - Функция paginate_comments_links() в WordPress с примерами.
Доступна с версии: 2.7
Раздел: Комментарии
Написал: Александр Сокирка

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

Для активации пагинации комментариев необходимо включить опцию на странице админ-панели: Настройки > Обсуждение. После активации, вы можете вывести ссылки навигации с помощью функции:

<?php paginate_comments_links(); ?>

Аналогичными функциями являются next_comments_link() и previous_comments_link(), которые выводят ссылки на следующую и предыдущую страницу комментариев соответственно.

Также существует функция the_comments_pagination(), которая является аналогом paginate_comments_links() и основана на функции paginate_links(). Это функция не имеет хуков.

Параметры функции paginate_comments_links()

Функция paginate_comments_links() принимает массив параметров, который позволяет настроить внешний вид и поведение навигационных ссылок. Вот некоторые из них:

  • prev_text: Текст для ссылки на предыдущую страницу.
  • next_text: Текст для ссылки на следующую страницу.
  • end_size: Количество страниц в начале и конце навигации, отображаемых с помощью числовых ссылок.
  • mid_size: Количество страниц, отображаемых вокруг текущей страницы.
  • before_page_number: HTML-код, который будет отображаться перед номером страницы.
  • after_page_number: HTML-код, который будет отображаться после номера страницы.

Возвращаемое значение

Функция paginate_comments_links() может возвращать:

  • null: Если параметр echo установлен в true и type не равен array.
  • Строку: HTML-код ссылок пагинации при echo равном false.
  • Массив: Ссылки пагинации при type равном array, plain или list.

Шаблон использования

Функция paginate_comments_links() принимает массив аргументов, который может включать следующие параметры:

paginate_comments_links( [
    'base'          => add_query_arg( 'cpage', '%#%' ),
    'format'        => null,
    'total'         => $max_page,
    'current'       => $page,
    'echo'          => true,
    'add_fragment'  => '#comments',
] );

Пример 1: Вывод постраничной навигации комментариев

Если в настройках включено разделение комментариев на страницы, используйте следующий код для вывода навигации:

<div class="navigation"><?php paginate_comments_links(); ?></div>

Пример 2: Изменение текстов ссылок «Следующая/Предыдущая страница»

Для изменения текста ссылок на следующую и предыдущую страницы, передайте аргументы prev_text и next_text:

<?php paginate_comments_links( array(
    'prev_text' => __('« Назад', 'your-text-domain'),
    'next_text' => __('Вперед »', 'your-text-domain')
) ); ?>

Если вам нужно использовать специальные HTML-символы, передавайте аргументы через массив:

<?php paginate_comments_links( array(
    'prev_text' => '«', 
    'next_text' => '»'
) ); ?>

Заключение

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

Стартовая премиум тема для WordPress
Демо импорт тестового контента в 1 клик.
SEO оптимизированный и валидный код.
Множество готовых стартовых сайтов.
Лучшая документация и поддержка.
Опции персонализации контента.
Креативный и современный дизайн.
Тема для WordPress

Дополнительно по: Комментарии