paginate_comments_links( string|array $args = array() )
Displays or retrieves pagination links for the comments on the current post.
Description
See also
Parameters
- $args
-
(Optional) args. See paginate_links().
Default value: array()
Return
(string|void) Markup for pagination links.
Source
File: wp-includes/link-template.php
function paginate_comments_links( $args = array() ) {
global $wp_rewrite;
if ( ! is_singular() )
return;
$page = get_query_var('cpage');
if ( !$page )
$page = 1;
$max_page = get_comment_pages_count();
$defaults = array(
'base' => add_query_arg( 'cpage', '%#%' ),
'format' => '',
'total' => $max_page,
'current' => $page,
'echo' => true,
'add_fragment' => '#comments'
);
if ( $wp_rewrite->using_permalinks() )
$defaults['base'] = user_trailingslashit(trailingslashit(get_permalink()) . $wp_rewrite->comments_pagination_base . '-%#%', 'commentpaged');
$args = wp_parse_args( $args, $defaults );
$page_links = paginate_links( $args );
if ( $args['echo'] )
echo $page_links;
else
return $page_links;
}
Changelog
Version | Description |
---|---|
WP-2.7.0 | Introduced. |