post_comments_feed_link( string $link_text = '', int $post_id = '', string $feed = '' )

Description

Compatibility

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

Parameters

$link_textstringoptional

Descriptive link text. Default 'Comments Feed'.Default: ''

$post_idintoptional

Post ID. Default is the ID of the global $post.Default: ''

$feedstringoptional

Feed type. Possible values include 'rss2', 'atom'.
Default is the value of get_default_feed().Default: ''

Performance profile

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

25–29

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

Plugin surface

1 hook

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

Called by

1

1 place 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 post_comments_feed_link()
• optionoption read or writeget_option()one call below post_comments_feed_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 · 2 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( post_comments_feed_link_html )filterline 854 (+17 into the body)

   Filters the post comment feed link anchor tag.

Uses · 4

• get_post_comments_feed_link()Retrieves the permalink for the post comments feed.
• __()Retrieves the translation of $text.
• esc_url()Checks and cleans a URL.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• comments_rss_link()Print RSS comment feed link.

Source code

View on Trac ↗View on GitHub ↗

837function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {838	$url = get_post_comments_feed_link( $post_id, $feed );839	if ( empty( $link_text ) ) {840		$link_text = __( 'Comments Feed' );841	}842 843	$link = '<a href="' . esc_url( $url ) . '">' . $link_text . '</a>';844	/**845	 * Filters the post comment feed link anchor tag.846	 *847	 * @since 2.8.0848	 *849	 * @param string $link    The complete anchor tag for the comment feed link.850	 * @param int    $post_id Post ID.851	 * @param string $feed    The feed type. Possible values include 'rss2', 'atom',852	 *                        or an empty string for the default feed type.853	 */854	echo apply_filters( 'post_comments_feed_link_html', $link, $post_id, $feed );855}

Changelog

Introduced in 2.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 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.