概要
wp_is_serving_rest_request関数は、現在のリクエストがWordPressのREST APIによって処理されているかどうかを調べるための関数です。この関数は、以下のような機能を実装する際に特によく使用されます。
- プラグインやテーマがREST APIエンドポイントの動作を確認するため。
- メタデータや特定のエンドポイントをREST APIを介して提供する際の条件分岐。
- ルートのリクエストに応じた特定のデータ処理を行う際。
- REST APIリクエストに関連するカスタム認証の実装。
- REST APIエンドポイントのキャッシュを制御するためのチェック。
- 外部アプリケーションと連携する際のレスポンス条件の設定。
- 他のリクエストとREST APIリクエストを区別して選択的な機能を有効化するため。
- ロギングやデバッグの条件を設定する場合。
構文
wp_is_serving_rest_request();
パラメータ
この関数にはパラメータはありません。
戻り値
この関数は、現在のリクエストがREST APIによって処理されている場合にtrueを、そうでない場合はfalseを返します。
関連する関数
使用可能なバージョン
この関数はWordPress 4.7.0以降で使用可能です。
コアファイルのパス
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_serving_rest_request関数は現時点で非推奨や削除されていません。