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

説明

基本構文

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;

使い分け早見表

関連項目

register_rest_route()、rest_url()

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