get_the_comments_navigation() │ WP 4.4.0

Получает ссылки на предыдущую/следующую страницы комментариев, если такие ссылки существуют. Используется на страницах записей в блоке комментариев.

Если результат этой функции нужно сразу вывести на экран, используйте the_comments_navigation()

Работает на основе: get_comment_pages_count(), get_previous_comments_link(), get_next_comments_link(), _navigation_markup()
Основа для: the_comments_navigation()
1 раз — 0.00276 сек (очень медленно) | 50000 раз — 5.96595 сек (быстро)

Хуков нет.

Возвращает

Строку. Готовый HTMl код блока пагинации для комментариев.

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

get_the_comments_navigation( $args );
$args(массив)

Параметры выводимого блока в виде массива. Может быть:

  • prev_text(строка)
    Текст анкора ссылки для предыдущих комментариев.
    По умолчанию: "Предыдущие комментарии"

  • next_text(строка)
    Текст анкора ссылки для следующих комментариев.
    По умолчанию: "Следующие комментарии"

  • screen_reader_text(строка)
    Текст для роботов читающих код. Используется для блока навигации.
    По умолчанию "Навигация по комментариям"

  • aria_label(строка) (WP 5.5)
    Значение атрибута area-label="" для <nav> элемента.
    По умолчанию: __( 'Posts' )

  • class(строка) (WP 5.5)
    Значение атрибута class="" для <nav> элемента.
    По умолчанию: 'post-navigation'

По умолчанию: array()

Примеры

0

#1 Демонстрация работы.

Допустим у записи 44 коммента и мы находимся на второй странице пагинации комментариев, тогда:

$html = get_the_comments_navigation();

$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">Previous comments</a>
		</div>
		<div class="nav-next">
			<a href="http://example.com/foo/comment-page-3#comments">Next comments</a>
		</div>
	</div>

</nav>

Список изменений

С версии 4.4.0 Введена.
С версии 5.3.0 Added the aria_label parameter.
С версии 5.5.0 Added the class parameter.

Код get_the_comments_navigation() WP 6.6.2

wp-includes/link-template.php 
function get_the_comments_navigation( $args = array() ) {
	$navigation = '';

	// Are there comments to navigate through?
	if ( get_comment_pages_count() > 1 ) {
		// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
		if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
			$args['aria_label'] = $args['screen_reader_text'];
		}

		$args = wp_parse_args(
			$args,
			array(
				'prev_text'          => __( 'Older comments' ),
				'next_text'          => __( 'Newer comments' ),
				'screen_reader_text' => __( 'Comments navigation' ),
				'aria_label'         => __( 'Comments' ),
				'class'              => 'comment-navigation',
			)
		);

		$prev_link = get_previous_comments_link( $args['prev_text'] );
		$next_link = get_next_comments_link( $args['next_text'] );

		if ( $prev_link ) {
			$navigation .= '<div class="nav-previous">' . $prev_link . '</div>';
		}

		if ( $next_link ) {
			$navigation .= '<div class="nav-next">' . $next_link . '</div>';
		}

		$navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
	}

	return $navigation;
}

Пагинация комментариев (навигация)

navigation pagination (навигация пагинация)

comment (комментарии)

Комментарии