get_search_feed_link() WordPress Function
The get_search_feed_link() function is used to generate a search RSS feed link for a given search query. This function takes two parameters: the search query and the feed type. The search query is used to generate the feed link, and the feed type can be either 'rss2' or 'atom'. If the search query is empty, then the function will return an empty string.
get_search_feed_link( string $search_query = '', string $feed = '' ) #
Retrieves the permalink for the search results 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 search results feed permalink.
Source
File: wp-includes/link-template.php
function get_search_feed_link( $search_query = '', $feed = '' ) { global $wp_rewrite; $link = get_search_link( $search_query ); if ( empty( $feed ) ) { $feed = get_default_feed(); } $permastruct = $wp_rewrite->get_search_permastruct(); if ( empty( $permastruct ) ) { $link = add_query_arg( 'feed', $feed, $link ); } else { $link = trailingslashit( $link ); $link .= "feed/$feed/"; } /** * Filters the search feed link. * * @since 2.5.0 * * @param string $link Search feed link. * @param string $feed Feed type. Possible values include 'rss2', 'atom'. * @param string $type The search type. One of 'posts' or 'comments'. */ return apply_filters( 'search_feed_link', $link, $feed, 'posts' ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |