get_the_comments_pagination( array $args = array() ): string
Retrieves a paginated navigation to next/previous set of comments, when applicable.
Contents
Description
See also
Parameters
-
$args
array Optional -
Default pagination arguments.
screen_reader_text
stringScreen reader text for the nav element. Default 'Comments navigation'.aria_label
stringARIA label text for the nav element. Default'Comments'
.class
stringCustom class for the nav element. Default'comments-pagination'
.
Default:
array()
Return
string Markup for pagination links.
Source
File: wp-includes/link-template.php
.
View all references
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;
}
Changelog
Version | Description |
---|---|
5.5.0 | Added the class parameter. |
5.3.0 | Added the aria_label parameter. |
4.4.0 | Introduced. |