get_comment_pages_count( WP_Comment[] $comments = null, int $per_page = null, bool $threaded = null )

Calculate the total number of comment pages.

Contents

Description Description

Parameters Parameters

$comments

(WP_Comment[]) (Optional) Array of WP_Comment objects. Defaults to $wp_query->comments.

Default value: null

$per_page

(int) (Optional) Comments per page.

Default value: null

$threaded

(bool) (Optional) Control over flat or threaded comments.

Default value: null

Top ↑

Return Return

(int) Number of comment pages.

Top ↑

Source Source

File: wp-includes/comment.php 

function get_comment_pages_count( $comments = null, $per_page = null, $threaded = null ) {
	global $wp_query;

	if ( null === $comments && null === $per_page && null === $threaded && ! empty( $wp_query->max_num_comment_pages ) ) {
		return $wp_query->max_num_comment_pages;
	}

	if ( ( ! $comments || ! is_array( $comments ) ) && ! empty( $wp_query->comments ) ) {
		$comments = $wp_query->comments;
	}

	if ( empty( $comments ) ) {
		return 0;
	}

	if ( ! get_option( 'page_comments' ) ) {
		return 1;
	}

	if ( ! isset( $per_page ) ) {
		$per_page = (int) get_query_var( 'comments_per_page' );
	}
	if ( 0 === $per_page ) {
		$per_page = (int) get_option( 'comments_per_page' );
	}
	if ( 0 === $per_page ) {
		return 1;
	}

	if ( ! isset( $threaded ) ) {
		$threaded = get_option( 'thread_comments' );
	}

	if ( $threaded ) {
		$walker = new Walker_Comment;
		$count  = ceil( $walker->get_number_of_root_elements( $comments ) / $per_page );
	} else {
		$count = ceil( count( $comments ) / $per_page );
	}

	return $count;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/link-template.php: get_the_comments_navigation()

Retrieves navigation to next/previous set of comments, when applicable.
wp-includes/link-template.php: get_next_comments_link()

Retrieves the link to the next comments page.
wp-includes/link-template.php: paginate_comments_links()

Displays or retrieves pagination links for the comments on the current post.
wp-includes/comment-template.php: wp_list_comments()

List comments.
wp-includes/comment-template.php: comments_template()

Load the comment template specified in $file.

Top ↑

User Contributed Notes User Contributed Notes

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Number of comments per page

    This will use the defaults for the number of comments per page and threading. You can use custom values like this:

    // Show 25 comments per page.
$pages = get_comment_pages_count( null, 25 );

// Don't thread comments.
$pages = get_comment_pages_count( null, null, false ); 

// Show 10 comments per page, use threading.
$pages = get_comment_pages_count( null, 10, true );
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Outside the loop

    When inside the loop, you can just pass null as the value for the $comment parameter, as shown above. You can also use the function outside the loop, but you need to pass in the array of comments. For example, you may perform a custom comment query using WP_Comment_Query:

    $args = array(
   // query args here
);

$comments_query = new WP_Comment_Query;
$comments = $comments_query->query( $args );

$pages = get_comment_pages_count( $comments );

You must log in before being able to contribute a note or feedback.