rest_format_combining_operation_error()

WordPressのrest_format_combining_operation_error()関数は、REST API操作中に発生したエラーをフォーマットするために使用されます。

構文

rest_format_combining_operation_error( string $error_code, string $error_message, int $status_code, array $additional_data = array() );

引数の説明:

• $error_code (string) — エラーコードを指定
• $error_message (string) — エラーメッセージを指定
• $status_code (int) — HTTPステータスコードを指定
• $additional_data (array) — 追加データを配列で指定

例1: 基本的なエラーフォーマット

REST APIエラーをシンプルにフォーマットします。

rest_format_combining_operation_error( 'invalid_param', 'パラメータが無効です', 400 );

例2: 追加データ付きエラー

追加データを含むエラーレスポンスを作成します。

rest_format_combining_operation_error( 'missing_field', '必須フィールドが不足しています', 422, array( 'field' => 'title' ) );

例3: 404エラーの生成

リソースが見つからない場合のエラーを生成します。

rest_format_combining_operation_error( 'not_found', 'リクエストされたリソースが見つかりません', 404 );

例4: 権限エラーの処理

アクセス権限がない場合のエラーレスポンス。

rest_format_combining_operation_error( 'forbidden', 'この操作を実行する権限がありません', 403 );

例5: カスタムエラーコードの使用例6: 複数フィールドのバリデーションエラー

複数のフィールドエラーを報告します。

rest_format_combining_operation_error( 'validation_failed', 'バリデーションに失敗しました', 400, array( 'fields' => array( 'email', 'password' ) ) );

例7: 内部サーバーエラーの生成

サーバー側の問題を示すエラー。

rest_format_combining_operation_error( 'internal_error', 'サーバーで問題が発生しました', 500 );

注意点

• ステータスコードはHTTP仕様に準拠する必要があります
• エラーメッセージはユーザーフレンドリーであることが推奨されます
• 追加データはAPIクライアントがエラーを処理するのに役立ちます