post_comments_feed_link( string $link_text = '', int $post_id = '', string $feed = '' )
Displays the comment feed link for a post.
Description
Prints out the comment feed link for a post. Link text is placed in the anchor. If no link text is specified, default text is used. If no post ID is specified, the current post is used.
Parameters
- $link_text
-
(Optional) Descriptive link text. Default 'Comments Feed'.
Default value: ''
- $post_id
-
(Optional) Post ID. Default is the ID of the global
$post.Default value: ''
- $feed
-
(Optional) Feed format.
Default value: ''
Source
File: wp-includes/link-template.php
function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
$url = get_post_comments_feed_link( $post_id, $feed );
if ( empty( $link_text ) ) {
$link_text = __('Comments Feed');
}
$link = '<a href="' . esc_url( $url ) . '">' . $link_text . '</a>';
/**
* Filters the post comment feed link anchor tag.
*
* @since WP-2.8.0
*
* @param string $link The complete anchor tag for the comment feed link.
* @param int $post_id Post ID.
* @param string $feed The feed type, or an empty string for the default feed type.
*/
echo apply_filters( 'post_comments_feed_link_html', $link, $post_id, $feed );
}
Changelog
| Version | Description |
|---|---|
| WP-2.5.0 | Introduced. |