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

Description

See also

• paginate_links()

Parameters

$argsstring|arrayoptional

Optional args. See paginate_links() .

More Arguments from paginate_links( … $args )

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

• base string
  Base of the paginated url.
• format string
  Format for the pagination structure.
• total int
  The total amount of pages. Default is the value WP_Query‘s max_num_pages or 1.
• current int
  The current page number. Default is 'paged' query var or 1.
• aria_current string
  The value for the aria-current attribute. Possible values are 'page', 'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'.
• show_all bool
  Whether to show all pages. Default false.
• end_size int
  How many numbers on either the start and the end list edges.
  Default 1.
• mid_size int
  How many numbers to either side of the current pages. Default 2.
• prev_next bool
  Whether to include the previous and next links in the list. Default true.
• prev_text string
  The previous page text. Default ‘« Previous’.
• next_text string
  The next page text. Default ‘Next »’.
• type string
  Controls format of the returned value. Possible values are 'plain', 'array' and 'list'. Default is 'plain'.
• add_args array
  An array of query args to add. Default false.
• add_fragment string
  A string to append to each link.
• before_page_number string
  A string to appear before the page number.
• after_page_number string
  A string to append after the page number.

Default:array()

Return

More Information

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.

Source

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

View all references View on Trac View on GitHub

Changelog