A WordPress-centric search engine for devs and theme authors



get_the_comments_pagination ›

Since4.4.0
Deprecatedn/a
get_the_comments_pagination ( $args = array() )
Parameters:
  • (array) $args { Optional. Default pagination arguments.
    Required: No
    Default: array()
See:
Returns:
  • (string) Markup for pagination links.
Defined at:
Codex:

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



Source

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