get_the_comments_pagination( array $args = array() )

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


Description Description


Parameters Parameters

$args

(array) (Optional) Default pagination arguments.

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

Default value: array()


Top ↑

Return Return

(string) Markup for pagination links.


Top ↑

Source Source

File: wp-includes/link-template.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;
}

Top ↑

Changelog Changelog

Changelog
Version Description
4.4.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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