get_comment_pages_count() │ WP 2.7.0

Counts the number of comment pages for a post (how many pages comments are split into).

Allows counting how many comment pages will result if considering the number of comments per page and their threaded output.

Usually, this function is not used before the start of the comment loop.

The function can be used outside the loop. Then, you need to specify the parameter $comments, and $per_page, $threaded if necessary.

Used By: get_the_comments_navigation(), get_next_comments_link()

No Hooks.

Returns

Int. The number of comment pages.

Usage

get_comment_pages_count( $comments, $per_page, $threaded );

$comments(array)

Array of comment objects. By default, the global variable $wp_query->comments is used.
Default: null

$per_page(int)

How many comments to display on one page. By default, it is taken from the settings.
Default: null

$threaded(bool)

Whether to consider the threadiness of comments or not. By default, it is taken from the settings. It can be:

false - do not consider, count each comment.
true - consider the comment tree, count the entire tree as one comment.

Default: null

Examples

#1 Example of using a function in the loop:

$pages = get_comment_pages_count();

#2 Example of using custom parameters

The example above uses all default values, which are taken from the settings. And this example shows how its parameters work:

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

// comment pages if you do not divide comments into tree-like type (thread comments).
$pages = get_comment_pages_count( null, null, false ); 

// pages of comments, if 10 per page and they are tree-like (thread comments).
$pages = get_comment_pages_count( null, 10, true );

#3 Using a function outside the comment loop

If the function is used outside the comment loop, you need to specify the $comments parameter, which contains an array of comments to be counted. Such an array can be obtained by necessary arguments, using class: WP_Comment_Query{}.

Get comments on the parameters you want and find out how many pages they break down into:

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

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

$pages = get_comment_pages_count( $comments );

Notes

Global. WP_Query. $wp_query WordPress Query object.

Changelog

Since 2.7.0

Introduced.

`get_comment_pages_count() get comment pages count` code ^{WP 6.8.3}

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 (int) $count;
}