rest_preload_api_request()


WordPressのrest_preload_api_request()関数は、REST APIリクエストを事前にプリロードするために使用されます。主にサーバーサイドレンダリングやパフォーマンス最適化に役立ちます。

構文

rest_preload_api_request( array $paths, string $namespace = 'wp/v2' );

引数の説明:

  • $paths (array) — プリロードするAPIエンドポイントの配列
  • $namespace (string) — REST APIの名前空間（デフォルトは’wp/v2’）

例1: 基本的なプリロード

投稿データをプリロードする例です。

rest_preload_api_request( array('/wp/v2/posts/'.get_the_ID()) );

例2: 複数のエンドポイントをプリロード

投稿とコメントを同時にプリロードします。

rest_preload_api_request( array('/wp/v2/posts/'.get_the_ID(),'/wp/v2/comments?post='.get_the_ID()) );

例3: カスタム名前空間を使用

カスタムプラグインのAPIエンドポイントをプリロードします。

rest_preload_api_request( array('/my-plugin/v1/data'), 'my-plugin/v1' );

例4: ページネーション付き投稿

ページネーションされた投稿リストをプリロードします。

rest_preload_api_request( array('/wp/v2/posts?page=1&per_page=10') );

例5: タクソノミーデータ

カテゴリーデータをプリロードします。

rest_preload_api_request( array('/wp/v2/categories/'.get_category(get_query_var('cat'))->term_id) );

例6: メディアデータ

投稿のサムネイル画像データをプリロードします。

rest_preload_api_request( array('/wp/v2/media/'.get_post_thumbnail_id(get_the_ID())) );

例7: ユーザーデータ

現在のユーザーデータをプリロードします。

rest_preload_api_request( array('/wp/v2/users/me') );

注意点

  • プリロードするデータ量が多すぎるとパフォーマンスに影響する可能性があります
  • 非公開データを含むエンドポイントには注意が必要です
  • キャッシュ戦略と併用すると効果的です

関連機能：