Displays or retrieves pagination links for the comments on the current post.

• paginate_links()

$args string|array Optional

args. See paginate_links() .

More Arguments from paginate_links( ... $args )

Array or string of arguments for generating paginated links for archives.

• basestring
  Base of the paginated url.
• formatstring
  Format for the pagination structure.
• totalint
  The total amount of pages. Default is the value WP_Query's max_num_pages or 1.
• currentint
  The current page number. Default is 'paged' query var or 1.
• aria_currentstring
  The value for the aria-current attribute. Possible values are 'page', 'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'.
• show_allbool
  Whether to show all pages. Default false.
• end_sizeint
  How many numbers on either the start and the end list edges.
  Default 1.
• mid_sizeint
  How many numbers to either side of the current pages. Default 2.
• prev_nextbool
  Whether to include the previous and next links in the list. Default true.
• prev_textstring
  The previous page text. Default '« Previous'.
• next_textstring
  The next page text. Default 'Next »'.
• typestring
  Controls format of the returned value. Possible values are 'plain', 'array' and 'list'. Default is 'plain'.
• add_argsarray
  An array of query args to add. Default false.
• add_fragmentstring
  A string to append to each link.
• before_page_numberstring
  A string to appear before the page number.
• after_page_numberstring
  A string to append after the page number.

Default: array()

void|string|array Void if 'echo' argument is true and 'type' is not an array, or if the query is not for an existing single post of any post type.
Otherwise, markup for comment page links or array of comment page links, depending on 'type' argument.

Defaults

$args = array(
'base' => add_query_arg( 'cpage', '%#%' ),
'format' => '',
'total' => $max_page,
'current' => $page,
'echo' => true,
'add_fragment' => '#comments'
);


Arguments passed in are merged to the defaults, via wp_parse_args() .
These arguments are mostly to make the call of paginate_links() work, so be careful if you change them.

File: wp-includes/link-template.php. View all references

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;
	}
}