WordPress at a glance

get_the_comments_navigation() WP 1.0

Retrieves navigation to next/previous set of comments, when applicable.

Is the basis for: the_comments_navigation()
✈ 1 time = 0.00276s = very slow | 50000 times = 5.96595s = fast

No Hooks.

Return

String. Markup for comments links.

Usage

get_the_comments_navigation( $args );
$args(array)

Optional.

  • $prev_text (string)
    Anchor text to display in the previous comments link.
    Default: 'Older comments'

  • $next_text (string)
    Anchor text to display in the next comments link.
    Default: 'Newer comments'

  • $screen_reader_text (string)
    Screen reader text for the nav element.
    Default: 'Comments navigation'

  • $aria_label (string)
    ARIA label text for the nav element.
    Default: 'Comments'

Default: comments navigation arguments

Changelog

Since 4.4.0 Introduced.
Since 5.3.0 Added the aria_label parameter.

Code of get the comments navigation: wp-includes/link-template.php WP 5.4.2

<?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' ),
			)
		);

		$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, 'comment-navigation', $args['screen_reader_text'], $args['aria_label'] );
	}

	return $navigation;
}

Related Functions

From tag: Comments pagination (navigation)

More from tag: Navigation pagination

More from tag: Comments

More from category: Comments

No comments
        Log In . Register