paginate_comments_links() WordPress Function

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,
		'type'         => 'plain',
		'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'] && 'array' !== $args['type'] ) {
		echo $page_links;
	} else {
		return $page_links;
	}
}
Uses	Description
wp-includes/formatting.php:trailingslashit()	Appends a trailing slash.
wp-includes/general-template.php:paginate_links()	Retrieves paginated links for archive post pages.
wp-includes/query.php:is_singular()	Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
wp-includes/query.php:get_query_var()	Retrieves the value of a query variable in the WP_Query class.
wp-includes/functions.php:wp_parse_args()	Merges user defined arguments into defaults array.
wp-includes/functions.php:add_query_arg()	Retrieves a modified URL query string.
wp-includes/link-template.php:get_permalink()	Retrieves the full permalink for the current post or post ID.
wp-includes/link-template.php:user_trailingslashit()	Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
wp-includes/class-wp-rewrite.php:WP_Rewrite::using_permalinks()	Determines whether permalinks are being used.
wp-includes/comment.php:get_comment_pages_count()	Calculates the total number of comment pages.