get_the_comments_pagination( array $args = array() )
Retrieves a paginated navigation to next/previous set of comments, when applicable.
Description
See also
Parameters
- $args
-
(Optional) Default pagination arguments.<br>
- 'screen_reader_text'
(string) Screen reader text for the nav element. Default 'Comments navigation'.<br> - 'aria_label'
(string) ARIA label text for the nav element. Default 'Comments'.<br> - 'class'
(string) Custom class for the nav element. Default 'comments-pagination'.<br>
Default value: array()
- 'screen_reader_text'
Return
(string) Markup for pagination links.
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;
}
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Added the class parameter. |
| 5.3.0 | Added the aria_label parameter. |
| 4.4.0 | Introduced. |