ワードプレスのfetch_feed関数の使用方法・解説

概要

fetch_feed関数は、RSSまたはAtom形式のフィードデータを読み込むために使用されるWordPressの関数です。この関数は、外部フィードから情報を取得し表示するための便利なツールであり、特に以下のような機能を実装する際によく使われます。

1. 外部ブログの最新投稿を表示
2. ニュースサイトからのフィードを集約
3. ソーシャルメディアの更新情報を表示
4. 特定のトピックに関連するフィードを表示
5. データの自動収集やリンク集の作成
6. フィードを通じて広告や情報をプッシュ送信
7. 任意のサードパーティサービスからの情報の統合
8. アプリケーション内のダッシュボード機能の実装

構文

fetch_feed( $url, $args );

パラメータ

• $url (string) : フィードのURL
• $args (array) : オプションの引数 (例: 禁止リクエスト、タイムアウト設定など)

戻り値

• SimplePieオブジェクト : フィードの情報が格納されたオブジェクト。

関連する関数

• fetch_feed
• simplepie

使用可能なバージョン

fetch_feed関数は、WordPress 2.1.0以降で利用可能です。

コアファイルのパス

wp-includes/class-simplepie.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: フィードの取得と表示

$url = 'https://example.com/feed/';
$feed = fetch_feed($url);

if (!is_wp_error($feed)) {
    foreach ($feed->get_items(0, 5) as $item) {
        echo '<h2>' . $item->get_title() . '</h2>';
        echo '<p>' . $item->get_description() . '</p>';
    }
}

• 説明: 指定したURLからフィードを取得し、最初の5つのアイテムのタイトルと説明を表示します。

サンプルコード 2: フィードのキャッシュを無効にする

$url = 'https://example.com/feed/';
$args = array('cache' => false);
$feed = fetch_feed($url, $args);

• 説明: デフォルトのキャッシュ機能を無効にしてフィードを取得します。

サンプルコード 3: タイムアウトを設定

$url = 'https://example.com/feed/';
$args = array('timeout' => 5);
$feed = fetch_feed($url, $args);

• 説明: フィード取得時のタイムアウトを5秒に設定します。

サンプルコード 4: エラーハンドリング

$url = 'https://example.com/feed/';
$feed = fetch_feed($url);

if (is_wp_error($feed)) {
    echo 'フィードの取得に失敗しました: ' . $feed->get_error_message();
}

• 説明: フィード取得の成功または失敗をチェックし、エラーメッセージを表示します。

サンプルコード 5: 独自のクエリ引数を追加

$url = 'https://example.com/feed/';
$args = array('n' => 10); // 10件のアイテムを取得
$feed = fetch_feed($url, $args);

• 説明: フィードから取得するアイテムの数を10に指定するカスタム引数を使用します。