rest_get_combining_operation_error()


WordPressのREST APIで使用される関数rest_get_combining_operation_error()は、複数の操作を組み合わせた際に発生するエラーを生成します。主にバッチリクエストや複数の操作を同時に実行する際に利用されます。

構文

rest_get_combining_operation_error( string $message, string $code, array $data = array() );

引数の説明:

  • $message (string) — エラーメッセージを指定します。
  • $code (string) — エラーコードを指定します。
  • $data (array) — 追加データを含む配列を指定します。

例1: 基本的なエラーの生成

シンプルなエラーを生成する例です。

rest_get_combining_operation_error( '操作に失敗しました', 'invalid_operation' );

例2: 追加データを含むエラー

エラーに追加データを含める例です。

rest_get_combining_operation_error( '無効なリクエスト', 'invalid_request', array( 'status' => 400 ) );

例3: バッチリクエストでのエラーハンドリング

バッチリクエスト中にエラーを返す例です。

if ( ! current_user_can( 'edit_posts' ) { rest_get_combining_operation_error( '権限がありません', 'rest_forbidden', array( 'status' => 403 ) ); }

例4: カスタムエラーコードの使用

独自のエラーコードを使用する例です。

rest_get_combining_operation_error( 'リソースが見つかりません', 'myplugin_resource_not_found' );

例5: 複数の操作エラーをまとめる

複数の操作で発生したエラーをまとめる例です。

$error1 = rest_get_combining_operation_error( '最初の操作失敗', 'operation_failed' ); $error2 = rest_get_combining_operation_error( '二番目の操作失敗', 'operation_failed' ); return array( $error1, $error2 );

例6: ステータスコード付きのエラー

HTTPステータスコードを指定する例です。

rest_get_combining_operation_error( 'サーバーエラー', 'server_error', array( 'status' => 500 ) );

例7: 条件付きエラーの生成

条件に基づいてエラーを生成する例です。

if ( ! isset( $_GET['id'] ) ) { rest_get_combining_operation_error( 'IDが指定されていません', 'missing_id', array( 'status' => 400 ) ); }

注意点

  • この関数はREST APIのコンテキストでのみ使用されます。
  • エラーメッセージは明確かつ簡潔に記述します。
  • 適切なHTTPステータスコードを設定します。