rest_get_route_for_post()


WordPressのrest_get_route_for_post()関数は、指定された投稿のREST APIルートを取得するために使用されます。この関数は投稿オブジェクトまたは投稿IDを受け取り、対応するREST APIエンドポイントのパスを返します。

構文

rest_get_route_for_post( int|WP_Post $post );
  • $post(int|WP_Post)—投稿IDまたはWP_Postオブジェクト。

例1:投稿IDからRESTルートを取得

投稿IDを使用してRESTルートを取得します。

$route = rest_get_route_for_post( get_the_ID() );

例2:カスタム投稿タイプのルート取得

カスタム投稿タイプのRESTルートを取得します。

$post = get_post( get_the_ID() ); $route = rest_get_route_for_post( $post );

例3:ルートを使用してAPIリクエストを実行

取得したルートを使用してAPIリクエストを送信します。

$route = rest_get_route_for_post( 123 ); $response = wp_remote_get( home_url( $route ) );

例4:投稿オブジェクトから直接ルート取得

WP_Queryループ内で投稿オブジェクトからルートを取得します。

global $post; $route = rest_get_route_for_post( $post );

例5:ルートの存在チェック

投稿がREST APIで利用可能かどうかを確認します。

if ( rest_get_route_for_post( get_the_ID() ) { /* 処理 */ }

例6:ルートをエスケープして表示

取得したルートを安全に表示します。

echo esc_url( rest_get_route_for_post( get_the_ID() ) );

例7:複数投稿のルートを一括取得

複数の投稿に対してルートを取得します。

$posts = get_posts(); foreach ( $posts as $post ) { $routes[] = rest_get_route_for_post( $post->ID ); }

注意点

  • 投稿が存在しない場合、関数は空の文字列を返します。
  • カスタム投稿タイプがREST APIで有効になっている必要があります。
  • 返されるルートはWordPressのURL構造に依存します。

関連機能：