rest_ensure_response()


WordPressのrest_ensure_response()関数は、REST APIのレスポンスを適切な形式に変換するために使用されます。この関数は、配列やオブジェクト、WP_ErrorオブジェクトなどをWP_REST_Responseオブジェクトに変換します。

構文

rest_ensure_response( mixed $data );
  • $data (mixed) — REST APIのレスポンスとして返すデータ。配列、オブジェクト、WP_Errorオブジェクトなどが指定可能です。

例1: 配列をレスポンスとして返す

配列をレスポンスとして返す基本的な例です。

$response = rest_ensure_response( array( 'message' => '成功' ) );

例2: WP_Errorオブジェクトをレスポンスとして返す

エラーが発生した場合にWP_Errorオブジェクトをレスポンスとして返します。

$error = new WP_Error( 'error_code', 'エラーメッセージ' );
$response = rest_ensure_response( $error );

例3: カスタムオブジェクトをレスポンスとして返す

カスタムオブジェクトをレスポンスとして返す例です。

class Custom_Object { public $message = 'カスタムメッセージ'; }
$custom_object = new Custom_Object();
$response = rest_ensure_response( $custom_object );

例4: 既存のWP_REST_Responseオブジェクトを返す

既にWP_REST_Responseオブジェクトである場合、そのまま返します。

$existing_response = new WP_REST_Response( array( 'message' => '既存のレスポンス' ) );
$response = rest_ensure_response( $existing_response );

例5: 文字列をレスポンスとして返す

文字列をレスポンスとして返す例です。

$response = rest_ensure_response( '文字列レスポンス' );

例6: 数値をレスポンスとして返す

数値をレスポンスとして返す例です。

$response = rest_ensure_response( 12345 );

例7: ネストされた配列をレスポンスとして返す

ネストされた配列をレスポンスとして返す例です。

$response = rest_ensure_response( array( 'data' => array( 'key' => 'value' ) ) );

例8: 空のレスポンスを返す

空のレスポンスを返す例です。

$response = rest_ensure_response( null );

注意点

  • rest_ensure_response()は、REST APIのレスポンスを統一するために使用されます。異なるデータ型を扱う際に便利です。
  • WP_Errorオブジェクトを渡す場合、適切なエラーレスポンスが生成されます。
  • 既にWP_REST_Responseオブジェクトである場合、そのまま返されるため、余計な処理が行われません。

関連機能：