get_comments_pagenum_link( int $pagenum = 1, int $max_page = 0 ): string
- Since
- 2.7.0
- Source
wp-includes/link-template.php:3080
Compatibility
- WordPress
- since 2.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$pagenumintoptional- Page number. Default 1.Default:
1 $max_pageintoptional- The maximum number of comment pages. Default 0.Default:
0
Return value
string- The comments page number link URL.
Performance profile
How much work a call to get_comments_pagenum_link() 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
- Heavy
- Scaling
- Constant
- Instructions
- 23–39
- Plugin surface
- 1 hook
- Called by
- 3
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 70.
Third-party callbacks on 'get_comments_pagenum_link' run inside this call, and their cost is not bounded by anything here.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below get_comments_pagenum_link() - cacheobject cache
wp_cache_get()one call below get_comments_pagenum_link() - serializeserialisation
maybe_unserialize()one call below get_comments_pagenum_link()
Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comments_pagenum_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 23 | get_permalink(), get_option(), apply_filters() |
!->using_permalinks() | 32–33 | get_permalink(), get_option(), ->using_permalinks(), add_query_arg(), apply_filters() |
->using_permalinks() | 39 | get_permalink(), get_option(), ->using_permalinks(), trailingslashit(), user_trailingslashit(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 70 instructions, 23–39 executed per call, 5 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while get_comments_pagenum_link() runs, in this order:
- apply_filters( get_comments_pagenum_link )filterline 3113 (+33 into the body)
Filters the comments page number link for the current request.
Uses · 6
- get_permalink()Retrieves the full permalink for the current post or post ID.
- get_option()Retrieves an option value based on an option name.
- user_trailingslashit()Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
- trailingslashit()Appends a trailing slash.
- add_query_arg()Retrieves a modified URL query string.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 3
- get_next_comments_link()Retrieves the link to the next comments page.
- get_previous_comments_link()Retrieves the link to the previous comments page.
- wp_get_canonical_url()Returns the canonical URL for a post.
Source code
function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) { global $wp_rewrite; $pagenum = (int) $pagenum; $max_page = (int) $max_page; $result = get_permalink(); if ( 'newest' === get_option( 'default_comments_page' ) ) { if ( $pagenum !== $max_page ) { if ( $wp_rewrite->using_permalinks() ) { $result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' ); } else { $result = add_query_arg( 'cpage', $pagenum, $result ); } } } elseif ( $pagenum > 1 ) { if ( $wp_rewrite->using_permalinks() ) { $result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' ); } else { $result = add_query_arg( 'cpage', $pagenum, $result ); } } $result .= '#comments'; /** * Filters the comments page number link for the current request. * * @since 2.7.0 * * @param string $result The comments page number link. */ return apply_filters( 'get_comments_pagenum_link', $result );}Changelog
Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/link-template.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.