概要
wp_is_rest_endpoint 関数は、REST APIのエンドポイントリクエストが現在処理中か調べるための関数です。この関数を使用することで、リクエストがREST APIのものであるかどうかを確認し、必要に応じて異なる処理を実行することができます。主に次のような機能を実装する際に使用されます。
- REST APIのカスタムエンドポイントを作成する際の条件分岐
- プラグインやテーマがREST APIリクエストでの振る舞いを調整する場合
- AjaxリクエストとREST APIリクエストを区別するため
- HTTPヘッダーを追加や変更するための条件付きロジック
- エラー処理の際にREST APIか通常リクエストかを判別するため
- 認証処理をREST APIリクエスト専用に実装する際
- カスタムデータの返却を管理するためにREST APIのリクエストを確認する場合
- セキュリティ対策として特定のエンドポイントへのアクセス制限を行う場合
構文
bool wp_is_rest_endpoint( $request = null );
パラメータ
$request(WP_REST_Request|array|null): リクエストオブジェクトまたは配列。デフォルトはnull。
戻り値
bool: 指定されたリクエストがREST APIエンドポイントである場合はtrue、そうでなければfalseを返します。
関連する関数
使用可能なバージョン
wp_is_rest_endpoint 関数は WordPress 4.4 以降で利用可能です。
コアファイルのパス
wp-includes/rest-api.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | 〇 |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
wp_is_rest_endpoint関数は特定のバージョンで非推奨や削除された情報はありません。