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

説明

基本構文

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

引数

• $path：エンドポイントのパス
• $scheme：スキーム

戻り値

REST APIのURL。

使い方（サンプル）

$endpoint = rest_url( 'wp/v2/posts' );

注意点

• パーマリンク設定によってURLの形式が変わるため、直接組み立てず、この関数を使います。

実務での使いどころ

• REST APIのURLを、JavaScriptへ渡すとき。
• 独自のエンドポイントの、URLを作るとき。

よくあるミスと対処

• /wp-json/ を、直接書いている。パーマリンク設定が「基本」のときは、URLの形式が違う。
• 出力するときに、エスケープしていない。

NG例

$url = home_url( '/wp-json/my-plugin/v1/items' ); // パーマリンクの設定で、形式が変わる

OK例

$url = rest_url( 'my-plugin/v1/items' );
wp_localize_script( 'my-script', 'myApi', array( 'url' => esc_url_raw( $url ) ) );

使い分け早見表

関連項目

register_rest_route()、get_rest_url()

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