rest_url()


WordPressのrest_url()関数は、REST APIのエンドポイントURLを生成するために使用されます。この関数は、サイトのREST APIのベースURLを返します。

構文

rest_url( string $path = '', string $scheme = 'rest' );

引数の説明:

  • $path(string) — REST APIのエンドポイントへのパスを指定します。デフォルトは空です。
  • $scheme(string) — URLのスキームを指定します。デフォルトは’rest’です。

例1: 基本的なREST APIのURLを取得

この例では、サイトのREST APIのベースURLを取得します。

<?php echo rest_url(); ?>

例2: 特定のエンドポイントのURLを取得

この例では、特定のエンドポイントのURLを取得します。

<?php echo rest_url('/wp/v2/posts'); ?>

例3: カスタムスキームを使用してURLを取得

この例では、カスタムスキームを使用してURLを取得します。

<?php echo rest_url('/wp/v2/posts', 'https'); ?>

例4: 投稿のREST APIエンドポイントを取得

この例では、特定の投稿のREST APIエンドポイントを取得します。

<?php echo rest_url('/wp/v2/posts/' . get_the_ID()); ?>

例5: カテゴリーのREST APIエンドポイントを取得

この例では、特定のカテゴリーのREST APIエンドポイントを取得します。

<?php echo rest_url('/wp/v2/categories/' . get_category(get_query_var('cat'))->term_id); ?>

例6: ユーザーのREST APIエンドポイントを取得

この例では、特定のユーザーのREST APIエンドポイントを取得します。

<?php echo rest_url('/wp/v2/users/' . get_current_user_id()); ?>

例7: メディアのREST APIエンドポイントを取得

この例では、特定のメディアのREST APIエンドポイントを取得します。

<?php echo rest_url('/wp/v2/media/' . get_post_thumbnail_id()); ?>

例8: カスタム投稿タイプのREST APIエンドポイントを取得

この例では、カスタム投稿タイプのREST APIエンドポイントを取得します。

<?php echo rest_url('/wp/v2/your_custom_post_type/' . get_the_ID()); ?>

注意点

  • rest_url()は、REST APIが有効になっている場合にのみ機能します。
  • カスタムスキームを使用する場合、適切なスキームを指定する必要があります。
  • エンドポイントのパスを指定する際は、正しい形式で指定してください。

関連機能：