get_rest_url() の使い方｜説明・引数・注意点

説明

基本構文

get_rest_url( int $blog_id = null, string $path = '/', string $scheme = 'rest' ): string

引数

• $blog_id：サイトのID（省略すると、現在のサイト）
• $path：REST APIのパス
• $scheme：URLのスキーム

戻り値

REST APIのURL。

使い方（サンプル）

$url = get_rest_url( null, 'my-plugin/v1/items' );

注意点

• パーマリンクの設定が「基本」のときは、URLの形式が違います（?rest_route= の形）。
• マルチサイトで、別のサイトのURLが必要なときに使います。

実務での使いどころ

• マルチサイトで、別のサイトのREST APIのURLを、取得するとき。

よくあるミスと対処

• /wp-json/ を、直接書いている。パーマリンク設定で、URLの形式が変わる。
• 現在のサイトだけでよいのに、これを使っている。rest_url() が簡単。

NG例

$url = home_url( '/wp-json/my-plugin/v1/items' ); // 形式を決め打ちしている

OK例

$url = get_rest_url( null, 'my-plugin/v1/items' );

使い分け早見表

関連項目

rest_url()、register_rest_route()

公式リファレンス：get_rest_url() | WordPress Developer Resources