rest_ensure_response() の使い方説明・引数・注意点
rest_ensure_response() は、データをREST APIのレスポンスオブジェクトに変換する関数です。
説明
rest_ensure_response() は、データをREST APIのレスポンスオブジェクトに変換する関数です。
基本構文
rest_ensure_response( WP_REST_Response|WP_Error|WP_HTTP_Response|mixed $response ): WP_REST_Response|WP_Error
引数
$response:レスポンスにするデータ
戻り値
WP_REST_Response。
使い方(サンプル)
return rest_ensure_response( array( 'ok' => true ) );
注意点
- REST APIのコールバックの戻り値として使います。
実務での使いどころ
- REST APIのコールバックで、戻り値を、
WP_REST_Responseに整えるとき。 - ヘッダーや、ステータスコードを、設定した応答を作るとき。
よくあるミスと対策
WP_Errorを、そのまま渡して、成功として扱っている。この関数は、WP_Errorをそのまま返す。- ステータスコードを、指定していない。作成の成功は、
201などにする。 - 配列を返すだけでよいのに、複雑にしている。配列を、そのまま返しても、WordPressが整える。
NG例
return array( 'ok' => true ); // ヘッダーやステータスを、設定できない
OK例
$response = rest_ensure_response( array( 'ok' => true ) );
$response->set_status( 201 );
return $response;
使い分け早見表
| 関数 | 役割 |
|---|---|
rest_ensure_response() |
戻り値を、REST用の応答に整える |
register_rest_route() |
エンドポイントを登録する |
wp_send_json() |
Ajax用に、JSONを出力して終了する |
PR エックスサーバー
WordPressを、速く・止まらずに運営したい方へ
サーバー選びを間違えると、表示が遅い・サイトが止まるリスクがあります
こんなお悩みはありませんか?
- どのレンタルサーバーを選べばよいか分からない
- 表示が遅い・サイトが落ちるのが心配
- WordPressの設定やセキュリティに自信がない
サーバーは、あとから乗り換えると、データの移行やドメインの設定に手間がかかります。表示が遅い、突然止まるといったトラブルは、訪問者が離れる原因にもなります。最初に、稼働率の保証や実績を確認して選ぶのが安全です。
エックスサーバーなら、WordPressの運営に強いレンタルサーバーを、迷わず選べます。国内でWordPressを利用して運用されているサイトの集計(Dataprovider.com調べ、2025年6月)で、国内シェアNo.1と公式サイトに記載されています。
選ばれるポイント
- WordPressサイトの国内シェアNo.1。実績で選びたいときの安心材料(Dataprovider.com調べ、2025年6月)
- サイトが止まりにくい。月間稼働率99.99%以上を保証し、下回ると月額費用の一部を返金
- 攻撃に強い。WordPressを狙った攻撃の99%以上を未然に防ぐ機能(2024年9月15日〜11月15日の当社調べ)
- ドメイン代を節約できる。独自ドメインが永久無料(対象ドメイン・契約期間などの条件あり)
- テーマ選びも安心。人気テーマ「Cocoon」の開発・提供元が運営
- 10日間の無料お試しで、契約前に操作や表示の速さを確かめられる
10日間の無料お試しで、契約前に試せます
10日間無料でお試し
広告(アフィリエイト)を含みます。特長は2026年11月8日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
register_rest_route()、rest_url()
公式リファレンス:rest_ensure_response() | Function | WordPress Developer Resources
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。