get_the_comments_pagination() WordPress Function
The get_the_comments_pagination() function is used to generate a paginated navigation for comments on a post or page. This function will return a string containing the pagination links.
get_the_comments_pagination( array $args = array() ) #
Retrieves a paginated navigation to next/previous set of comments, when applicable.
Description
See also
Parameters
- $args
(array)(Optional)Default pagination arguments.
- 'screen_reader_text'
(string) Screen reader text for the nav element. Default 'Comments navigation'. - 'aria_label'
(string) ARIA label text for the nav element. Default 'Comments'. - 'class'
(string) Custom class for the nav element. Default 'comments-pagination'.
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 = '';
// 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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Added the class parameter. |
| 5.3.0 | Added the aria_label parameter. |
| 4.4.0 | Introduced. |