get_the_comments_navigation() │ WP 4.4.0

Gets links to the previous/next comment pages, if such links exist. Used on post pages in the comments block.

If the result of this function needs to be displayed immediately, use the_comments_navigation()

Uses: get_comment_pages_count(), get_previous_comments_link(), get_next_comments_link(), _navigation_markup()
Used By: the_comments_navigation()
1 time — 0.00276 sec (very slow) | 50000 times — 5.96595 sec (fast)

No Hooks.

Returns

String. Ready HTML code of the pagination block for comments.

Usage

get_the_comments_navigation( $args );
$args(array)

Parameters of the output block as an array. Can be:

  • prev_text(string)
    Text of the anchor link for previous comments.
    Default: "Previous comments"

  • next_text(string)
    Text of the anchor link for next comments.
    Default: "Next comments"

  • screen_reader_text(string)
    Text for robots reading the code. Used for the navigation block.
    Default "Comment navigation"

  • aria_label(string) (WP 5.5)
    Value of the attribute area-label="" for <nav> element.
    Default: __( 'Posts' )

  • class(string) (WP 5.5)
    Value of the attribute class="" for <nav> element.
    Default: 'post-navigation'

Default: array()

Examples

0

#1 Demo

Suppose the post has 44 comments and we are on the second page of the comment pagination, then:

$html = get_the_comments_navigation();

$html will contain:

<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>

Changelog

Since 4.4.0 Introduced.
Since 5.3.0 Added the aria_label parameter.
Since 5.5.0 Added the class parameter.

get_the_comments_navigation() code WP 6.8.3

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;
}

Comments pagination (navigation)

Navigation pagination

Comments

Comments