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



get_the_comments_pagination › WordPress Function

Since4.4.0
Deprecatedn/a
get_the_comments_pagination ( $args = array() )
Parameters:
  • (array) $args { Optional. Default pagination arguments. @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments pagination'. @type string $aria_label ARIA label text for the nav element. Default 'Comments pagination'. @type string $class Custom class for the nav element. Default 'comments-pagination'. }
    Required: No
    Default: array()
See:
Returns:
  • (string) Markup for pagination links.
Defined at:
Codex:
Change Log:
  • 5.3.0
  • 5.5.0

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



Source

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 pagination' ),
			'aria_label'         => __( 'Comments pagination' ),
			'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;
}