W3cubDocs

/WordPress

get_search_comments_feed_link( string $search_query = '', string $feed = '' )

Retrieves the permalink for the search results comments feed.

Parameters

$search_query

(string) (Optional) Search query.

Default value: ''

$feed

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

Default value: ''

Return

(string) The comments feed search results permalink.

Source

File: 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' );
}

Uses

Uses Description
wp-includes/functions.php: add_query_arg()

Retrieves a modified URL query string.
wp-includes/link-template.php: get_search_feed_link()

Retrieves the permalink for the search results feed.
wp-includes/link-template.php: search_feed_link

Filters the search feed link.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/feed.php: get_default_feed()

Retrieve the default feed.
wp-includes/class-wp-rewrite.php: WP_Rewrite::get_search_permastruct()

Retrieves the search permalink structure.

Changelog

Version Description
2.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_search_comments_feed_link