rest_get_route_for_term()


WordPressのrest_get_route_for_term()関数は、指定されたタームのREST APIルートを取得するために使用されます。

構文

rest_get_route_for_term( int|WP_Term $term );
  • $term(int|WP_Term)—タームIDまたはWP_Termオブジェクト

例1:タームIDからRESTルートを取得

カテゴリーIDからRESTルートを取得します。

$route = rest_get_route_for_term(get_category(5)->term_id);

例2:タグオブジェクトからRESTルートを取得

WP_Termオブジェクトを使用してルートを取得します。

$tag = get_tag(7); $route = rest_get_route_for_term($tag);

例3:カスタムタクソノミーのタームルート取得

カスタムタクソノミーのタームに対してルートを取得します。

$term = get_term_by('slug','news','custom_tax'); $route = rest_get_route_for_term($term);

例4:存在しないタームの場合

存在しないタームIDを指定した場合の挙動。

$route = rest_get_route_for_term(9999);

例5:ルートをエコーする

取得したルートを直接出力します。

echo rest_get_route_for_term(get_term(3)->term_id);

例6:配列で複数タームのルートを取得

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

foreach([1,2,3] as $id){$routes[]=rest_get_route_for_term($id);}

例7:取得したルートをRESTリクエストに使用

取得したルートを使ってAPIリクエストを行います。

$route = rest_get_route_for_term(5); $response = wp_remote_get(rest_url($route));

注意事項

  • タームが存在しない場合、関数はfalseを返す可能性があります
  • REST APIが有効になっている必要があります
  • タクソノミーがREST APIで公開されている必要があります

関連機能：