paginate_comments_links( string|array $args = array() ): void|string|array
- Since
- 2.7.0
- Source
wp-includes/link-template.php:3253
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
$argsstring|arrayoptional- Optional args. See paginate_links(). Default empty array.Default:
array()
Return value
void|string|array- Void if 'echo' argument is true and 'type' is not an array, or if the query is not for an existing single post of any post type.
Otherwise, markup for comment page links or array of comment page links, depending on 'type' argument.
Performance profile
How much work a call to paginate_comments_links() 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
- 6–59
- Plugin surface
- None
- Called by
- 2
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 61.
Nothing here hands control to plugin code.
2 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()one call below paginate_comments_links() - hookthird-party callbacks
apply_filters()one call below paginate_comments_links() - querycontent query
get_post()one call below paginate_comments_links()
Further down the call graph this can also reach cache, serialize 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost paginate_comments_links() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_singular() | 6 | is_singular() |
is_singular() && !->using_permalinks() | 40–45 | is_singular(), get_query_var(), get_comment_pages_count(), add_query_arg(), ->using_permalinks(), wp_parse_args(), paginate_links() |
is_singular() && ->using_permalinks() | 54–59 | is_singular(), get_query_var(), get_comment_pages_count(), add_query_arg(), ->using_permalinks(), get_permalink(), trailingslashit(), user_trailingslashit(), wp_parse_args(), paginate_links() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 61 instructions, 6–59 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.
Uses · 9
- is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
- get_query_var()Retrieves the value of a query variable in the WP_Query class.
- get_comment_pages_count()Calculates the total number of comment pages.
- add_query_arg()Retrieves a modified URL query string.
- user_trailingslashit()Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
- trailingslashit()Appends a trailing slash.
- get_permalink()Retrieves the full permalink for the current post or post ID.
- wp_parse_args()Merges user defined arguments into defaults array.
- paginate_links()Retrieves paginated links for archive post pages.
Used by · 2
- get_the_comments_pagination()Retrieves a paginated navigation to next/previous set of comments, when applicable.
- render_block_core_comments_pagination_numbers()Renders the `core/comments-pagination-numbers` block on the server.
Source code
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; }}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 6.8.8 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.