函数文档

get_search_comments_feed_link()

💡 云策文档标注

概述

get_search_comments_feed_link() 函数用于获取搜索结果评论订阅的固定链接。它基于搜索查询和订阅类型生成链接,并处理不同的永久链接结构。

关键要点

  • 函数返回搜索结果评论订阅的固定链接字符串。
  • 接受两个可选参数:$search_query(搜索查询字符串,默认为空)和 $feed(订阅类型,如 'rss2' 或 'atom',默认为 get_default_feed() 的值)。
  • 内部调用 get_search_feed_link() 获取基础链接,并根据 WP_Rewrite 的永久链接结构添加查询参数(如 'feed' 或 'withcomments')。
  • 通过 apply_filters('search_feed_link', $link, $feed, 'comments') 应用过滤器,允许开发者自定义链接。

代码示例

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

注意事项

  • 函数自 WordPress 2.5.0 版本引入,兼容性良好。
  • 相关函数包括 get_search_feed_link()、get_default_feed()、WP_Rewrite::get_search_permastruct()、add_query_arg() 和 apply_filters(),用于辅助链接生成和过滤。
  • 使用前需确保 $wp_rewrite 全局变量已初始化,以正确处理永久链接结构。

📄 原文内容

Retrieves the permalink for the search results comments feed.

Parameters

$search_querystringoptional
Search query. Default empty.
$feedstringoptional
Feed type. Possible values include 'rss2', 'atom'.
Default is the value of get_default_feed() .

Return

string The comments feed search results permalink.

Source

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

Hooks

apply_filters( ‘search_feed_link’, string $link, string $feed, string $type )

Filters the search feed link.

Changelog

Version Description
2.5.0 Introduced.