get_the_comments_navigation( array $args = array() ): string

In this article

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

Parameters

$argsarrayoptional
Default comments navigation arguments.
  • 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'.
  • class string
    Custom class for the nav element. Default 'comment-navigation'.

Default:array()

Return

string Markup for comments links.

Source

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

Changelog

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

User Contributed Notes

You must log in before being able to contribute a note or feedback.