rest_get_queried_resource_route()


WordPressのrest_get_queried_resource_route()関数は、現在のREST APIリクエストでクエリされたリソースのルートを取得します。主にREST APIのエンドポイント処理で使用されます。

構文

rest_get_queried_resource_route();
  • (string|false) — 成功時はルート文字列、失敗時はfalseを返します。

例1: 基本の使用法

現在のREST APIリクエストのルートを取得します。

$route = rest_get_queried_resource_route();

例2: ルートの存在確認

ルートが存在するかどうかをチェックします。

if (rest_get_queried_resource_route()) { echo 'ルートあり'; }

例3: カスタムエンドポイントでの使用

カスタムREST APIエンドポイント内でルートを取得します。

add_action('rest_api_init', function() { $route = rest_get_queried_resource_route(); });

例4: ルートを変数に代入

取得したルートを変数に格納して後で使用します。

$current_route = rest_get_queried_resource_route();

例5: デバッグ用途

デバッグ時に現在のルートを出力します。

var_dump(rest_get_queried_resource_route());

例6: 条件分岐での使用

特定のルートかどうかで処理を分岐させます。

if (rest_get_queried_resource_route() === '/wp/v2/posts') { // 処理 }

例7: エラーハンドリング

ルート取得失敗時の処理を追加します。

$route = rest_get_queried_resource_route(); if (!$route) { wp_die('ルート取得失敗'); }

注意点

  • REST APIリクエスト外ではfalseを返します
  • 権限チェックは別途必要です
  • プラグインによって変更される可能性があります

関連機能: