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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$commentsWP_Comment[]optional

Array of WP_Comment objects. Defaults to $wp_query->comments.Default: null

$per_pageintoptional

Comments per page. Defaults to the value of comments_per_page query var, option of the same name, or 1 (in that order).Default: null

$threadedbooloptional

Control over flat or threaded comments. Defaults to the value of thread_comments option.Default: null

Return value

int

Number of comment pages.

Performance profile

How much work a call to get_comment_pages_count() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

12–61

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 71.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below get_comment_pages_count()
• cacheobject cachewp_cache_get()one call below get_comment_pages_count()
• serializeserialisationmaybe_unserialize()one call below get_comment_pages_count()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 17 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_pages_count() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• get_option()Retrieves an option value based on an option name.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• Walker_Comment::__construct()

Used by · 6

• comments_template()Loads the comment template specified in $file.
• get_next_comments_link()Retrieves the link to the next comments page.
• get_the_comments_navigation()Retrieves navigation to next/previous set of comments, when applicable.
• paginate_comments_links()Displays or retrieves pagination links for the comments on the current post.
• twentyfifteen_comment_nav()Display navigation to next/previous comments when applicable.
• wp_list_comments()Displays a list of comments.

Source code

View on Trac ↗View on GitHub ↗

944function get_comment_pages_count( $comments = null, $per_page = null, $threaded = null ) {945	global $wp_query;946 947	if ( null === $comments && null === $per_page && null === $threaded && ! empty( $wp_query->max_num_comment_pages ) ) {948		return $wp_query->max_num_comment_pages;949	}950 951	if ( ( ! $comments || ! is_array( $comments ) ) && ! empty( $wp_query->comments ) ) {952		$comments = $wp_query->comments;953	}954 955	if ( empty( $comments ) ) {956		return 0;957	}958 959	if ( ! get_option( 'page_comments' ) ) {960		return 1;961	}962 963	if ( ! isset( $per_page ) ) {964		$per_page = (int) get_query_var( 'comments_per_page' );965	}966	if ( 0 === $per_page ) {967		$per_page = (int) get_option( 'comments_per_page' );968	}969	if ( 0 === $per_page ) {970		return 1;971	}972 973	if ( ! isset( $threaded ) ) {974		$threaded = get_option( 'thread_comments' );975	}976 977	if ( $threaded ) {978		$walker = new Walker_Comment();979		$count  = ceil( $walker->get_number_of_root_elements( $comments ) / $per_page );980	} else {981		$count = ceil( count( $comments ) / $per_page );982	}983 984	return (int) $count;985}

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/comment.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.