Функция get_the_comments_navigation() используется для получения HTML-разметки навигации по комментариям, если на странице поста есть несколько страниц с комментариями. Она генерирует ссылки для перехода к предыдущим и следующим комментариям.
get_the_comments_navigation( array $args = array() ): stringАргументы:
$args(array) — Опциональный массив с параметрами:'prev_text'(string) — Текст ссылки на предыдущие комментарии. По умолчанию:'Older comments'.'next_text'(string) — Текст ссылки на следующие комментарии. По умолчанию:'Newer comments'.'screen_reader_text'(string) — Текст для скринридеров. По умолчанию:'Comments navigation'.'aria_label'(string) — ARIA label для элемента навигации. По умолчанию:'Comments'.'class'(string) — CSS-класс для элемента навигации. По умолчанию:'comment-navigation'.
Возвращаемое значение:
- Возвращает строку с HTML-кодом для навигации по комментариям.
Использование:
Функция обычно используется на страницах записей для отображения навигации между комментариями, когда они разбиваются на несколько страниц. Если нужно сразу вывести результат, следует использовать функцию the_comments_navigation().
Пример 1: Стандартная навигация по комментариям
Этот пример демонстрирует использование функции для вывода навигации по страницам комментариев с настройками по умолчанию.
$html = get_the_comments_navigation();
echo $html;Если на текущей записи есть несколько страниц с комментариями, результат будет таким:
<nav class="navigation comment-navigation" role="navigation">
<h2 class="screen-reader-text">Comments navigation</h2>
<div class="nav-links">
<div class="nav-previous">
<a href="http://example.com/foo/comment-page-1#comments">Older comments</a>
</div>
<div class="nav-next">
<a href="http://example.com/foo/comment-page-3#comments">Newer comments</a>
</div>
</div>
</nav>Пример 2: Настройка текста и атрибутов
Вы можете изменить текст ссылок и добавить собственные атрибуты для навигации, передав массив аргументов:
$args = array(
'prev_text' => 'Предыдущие комментарии',
'next_text' => 'Следующие комментарии',
'screen_reader_text' => 'Навигация по комментариям',
'aria_label' => 'Комментарии',
'class' => 'custom-comment-navigation'
);
$html = get_the_comments_navigation( $args );
echo $html;
Как это работает
Функция использует следующие вспомогательные функции:
get_comment_pages_count()— для получения общего числа страниц комментариев.get_previous_comments_link()— для получения ссылки на предыдущие комментарии.get_next_comments_link()— для получения ссылки на следующие комментарии._navigation_markup()— для генерации HTML-разметки навигации.
Заключение
Функция get_the_comments_navigation() является полезной для сайтов с большим количеством комментариев. Она помогает пользователям легко перемещаться между страницами с комментариями, предоставляя возможность настроить текст ссылок и внешний вид блока навигации.