get_search_comments_feed_link() │ WP 2.5.0

Retrieves the permalink for the search results comments feed.

Hooks from the function

Return

String. The comments feed search results permalink.

Usage

get_search_comments_feed_link( $search_query, $feed );
$search_query(string)
Search query.
Default: ''
$feed(string)
Feed type. Possible values include 'rss2', 'atom'.
Default: value of get_default_feed()

Notes

  • Global. WP_Rewrite. $wp_rewrite WordPress rewrite component.

Changelog

Since 2.5.0 Introduced.

get_search_comments_feed_link() code WP 6.5.2

wp-includes/link-template.php 
function get_search_comments_feed_link( $search_query = '', $feed = '' ) {
	global $wp_rewrite;

	if ( empty( $feed ) ) {
		$feed = get_default_feed();
	}

	$link = get_search_feed_link( $search_query, $feed );

	$permastruct = $wp_rewrite->get_search_permastruct();

	if ( empty( $permastruct ) ) {
		$link = add_query_arg( 'feed', 'comments-' . $feed, $link );
	} else {
		$link = add_query_arg( 'withcomments', 1, $link );
	}

	/** This filter is documented in wp-includes/link-template.php */
	return apply_filters( 'search_feed_link', $link, $feed, 'comments' );
}