概要
get_feed_link関数は、指定されたフィード形式のURLを取得するために使用されます。この関数は、さまざまなフィードのURLを動的に生成する際によく利用されます。以下は、get_feed_link関数がよく使われるシナリオの例です：
- RSSフィードのリンクを出力する際
- Atomフィードのリンクを生成する際
- カスタムフィードを作成する際
- フィードを購読するためのURLをテンプレートに埋め込む際
- ウィジェットやショートコードでフィードリンクを表示する際
- ソーシャルメディアでシェア用のフィードリンクを作成する際
- SEOの最適化を目的としたXMLフィードのリンクを表示する際
- ユーザー向けのコンテンツ更新情報を提供する際
構文
get_feed_link( $feed )
パラメータ
$feed(string) – フィードの形式（例: ‘rss2’, ‘atom’, ‘rdf’など）。指定しない場合は、デフォルトのフィードが取得されます。
戻り値
- (string) 指定されたフィード形式のURL。フィードが存在しない場合は、空の文字列が返されます。
関連する関数
使用可能なバージョン
get_feed_link関数はWordPress 2.0で導入され、以降のバージョンでもサポートされています。
コアファイルのパス
wp-includes/feed.php
この関数のアクションでの使用可能性
| アクション | 使用可能 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプル1: RSSフィードリンクの取得
$feed_url = get_feed_link('rss2');
echo '<a href="' . esc_url($feed_url) . '">Subscribe to RSS</a>';
このコードは、RSSフィードのURLを取得し、リンクとして出力します。
サンプル2: Atomフィードリンクの取得
$feed_url = get_feed_link('atom');
echo '<link rel="alternate" type="application/atom+xml" href="' . esc_url($feed_url) . '" title="Atom Feed">';
このコードは、AtomフィードのURLを取得し、HTMLの<link>タグで出力します。
サンプル3: カスタムフィードの取得
$custom_feed_url = get_feed_link('custom-feed');
if ($custom_feed_url) {
echo '<a href="' . esc_url($custom_feed_url) . '">Subscribe to Custom Feed</a>';
}
このコードは、カスタムフィードのURLを取得し、存在する場合にリンクを出力します。
サンプル4: フィードリンクの条件付き出力
if ( is_single() ) {
$feed_url = get_feed_link('rss2');
echo '<a href="' . esc_url($feed_url) . '">Subscribe to RSS for this post</a>';
}
このコードは、シングル投稿ページの場合にのみRSSフィードのリンクを出力します。
サンプル5: フィードリンクをウィジェットで使用
class My_Widget extends WP_Widget {
function widget($args, $instance) {
// フィードリンクを取得
$feed_url = get_feed_link('rss2');
echo '<div class="widget">';
echo '<h2>Subscribe</h2>';
echo '<a href="' . esc_url($feed_url) . '">Subscribe to RSS</a>';
echo '</div>';
}
}
このコードは、カスタムウィジェット内でRSSフィードのリンクを表示します。