get_the_comments_pagination() WP 1.0

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

No Hooks.

Return

String. Markup for pagination links.

Usage

get_the_comments_pagination( $args );

$args(array)

Optional.

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

Default: pagination arguments

Notes

• See: paginate_comments_links()

Changelog

Code of get the comments pagination: wp-includes/link-template.php ^{WP 5.2.4}

<?php
function get_the_comments_pagination( $args = array() ) {
	$navigation   = '';
	$args         = wp_parse_args(
		$args,
		array(
			'screen_reader_text' => __( 'Comments navigation' ),
		)
	);
	$args['echo'] = false;

	// Make sure we get a string back. Plain is the next best thing.
	if ( isset( $args['type'] ) && 'array' == $args['type'] ) {
		$args['type'] = 'plain';
	}

	$links = paginate_comments_links( $args );

	if ( $links ) {
		$navigation = _navigation_markup( $links, 'comments-pagination', $args['screen_reader_text'] );
	}

	return $navigation;
}

Related Functions

From tag: Navigation pagination

More from tag: Comments

More from category: Comments