get_next_comments_link( string $label = '', int $max_page = 0, int|null $page = null ): string|void

Compatibility

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

Parameters

$labelstringoptional

Label for link text. Default empty.Default: ''

$max_pageintoptional

Max page. Default 0.Default: 0

$pageint|nulloptional

Page number. Default null.Default: null

Return value

string|void

HTML-formatted link for the next page of comments.

Performance profile

How much work a call to get_next_comments_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

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

8–55

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

Plugin surface

1 hook

Third-party callbacks on 'next_comments_link_attributes' run inside this call, and their cost is not bounded by anything here.

Called by

4

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below get_next_comments_link()

Further down the call graph this can also reach cache, serialize, 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 · 12 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while get_next_comments_link() runs, in this order:

1. 1
   apply_filters( next_comments_link_attributes )filterline 3169 (+40 into the body)

   Filters the anchor tag attributes for the next comments page link.

Uses · 7

• 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.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_url()Checks and cleans a URL.
• get_comments_pagenum_link()Retrieves the comments page number link.

Used by · 4

• get_the_comments_navigation()Retrieves navigation to next/previous set of comments, when applicable.
• next_comments_link()Displays the link to the next comments page.
• render_block_core_comments_pagination_next()Renders the `core/comments-pagination-next` block on the server.
• twentyfifteen_comment_nav()Displays navigation to next/previous comments when applicable.

Source code

View on Trac ↗View on GitHub ↗

3129function get_next_comments_link( $label = '', $max_page = 0, $page = null ) {3130	global $wp_query;3131 3132	if ( ! is_singular() ) {3133		return;3134	}3135 3136	if ( is_null( $page ) ) {3137		$page = get_query_var( 'cpage' );3138	}3139 3140	if ( ! $page ) {3141		$page = 1;3142	}3143 3144	$next_page = (int) $page + 1;3145 3146	if ( empty( $max_page ) ) {3147		$max_page = $wp_query->max_num_comment_pages;3148	}3149 3150	if ( empty( $max_page ) ) {3151		$max_page = get_comment_pages_count();3152	}3153 3154	if ( $next_page > $max_page ) {3155		return;3156	}3157 3158	if ( empty( $label ) ) {3159		$label = __( 'Newer Comments &raquo;' );3160	}3161 3162	/**3163	 * Filters the anchor tag attributes for the next comments page link.3164	 *3165	 * @since 2.7.03166	 *3167	 * @param string $attributes Attributes for the anchor tag.3168	 */3169	$attr = apply_filters( 'next_comments_link_attributes', '' );3170 3171	return sprintf(3172		'<a href="%1$s" %2$s>%3$s</a>',3173		esc_url( get_comments_pagenum_link( $next_page, $max_page ) ),3174		$attr,3175		preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label )3176	);3177}

Changelog

Introduced in 2.7.1. One change between 6.7.7 and 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.9.7 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.