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 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: 'comments-pagination'

Default: pagination arguments

Notes

• See: paginate_comments_links()

Changelog

Code of get_the_comments_pagination() get the comments pagination ^{WP 5.6}

<?php
function get_the_comments_pagination( $args = array() ) {
	$navigation = '';

	// 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(
			'screen_reader_text' => __( 'Comments navigation' ),
			'aria_label'         => __( 'Comments' ),
			'class'              => 'comments-pagination',
		)
	);
	$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, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
	}

	return $navigation;
}

Related Functions

From tag: Navigation pagination

More from tag: Comments

More from category: Comments