wpseek.com
A WordPress-centric search engine for devs and theme authors



get_the_comments_navigation › WordPress Function

Since4.4.0
Deprecatedn/a
get_the_comments_navigation ( $args = array() )
Parameters:
  • (array) $args { Optional. Default comments navigation arguments. @type string $prev_text Anchor text to display in the previous comments link. Default 'Older comments'. @type string $next_text Anchor text to display in the next comments link. Default 'Newer comments'. @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'. @type string $aria_label ARIA label text for the nav element. Default 'Comments'. @type string $class Custom class for the nav element. Default 'comment-navigation'. }
    Required: No
    Default: array()
Returns:
  • (string) Markup for comments links.
Defined at:
Codex:
Change Log:
  • 5.3.0
  • 5.5.0

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



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