get_comments_link( int|WP_Post $post = 0 ): string

Compatibility

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

Parameters

$postint|WP_Postoptional

Post ID or WP_Post object. Default is global $post.Default: 0

Return value

string

The link to the comments.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

17–18

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

Plugin surface

1 hook

Third-party callbacks on 'get_comments_link' 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
• querycontent queryget_post()one call below get_comments_link()
• optionoption read or writeget_option()one call below get_comments_link()

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 · 1 distinct outcome

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( get_comments_link )filterline 885 (+12 into the body)

   Filters the returned post comments permalink.

Uses · 3

• get_comments_number()Retrieves the amount of comments a post has.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 4

• comments_link()Displays the link to the current post comments.
• comments_link_feed()Outputs the link to the comments for the current post in an XML safe way.
• comments_popup_link()Displays the link to the comments for the current post ID.
• render_block_core_post_comments_link()Renders the `core/post-comments-link` block on the server.

Source code

View on Trac ↗View on GitHub ↗

873function get_comments_link( $post = 0 ) {874	$hash          = get_comments_number( $post ) ? '#comments' : '#respond';875	$comments_link = get_permalink( $post ) . $hash;876 877	/**878	 * Filters the returned post comments permalink.879	 *880	 * @since 3.6.0881	 *882	 * @param string      $comments_link Post comments permalink with '#comments' appended.883	 * @param int|WP_Post $post          Post ID or WP_Post object.884	 */885	return apply_filters( 'get_comments_link', $comments_link, $post );886}

Changelog

Introduced in 1.5.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 7.0.4 tag, from src/wp-includes/comment-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.