_json_wp_die_handler()


WordPressの_json_wp_die_handler()関数は、JSON形式でエラーメッセージを返すためのハンドラーです。主にREST APIやAJAXリクエストで使用されます。

構文

_json_wp_die_handler( $message, $title = '', $args = array() );

引数の説明:

  • $message(string|WP_Error)—表示するエラーメッセージまたはWP_Errorオブジェクト。
  • $title(string)—エラータイトル（オプション）。
  • $args(array)—追加の引数（例：’response’コード）。

例1:基本的なJSONエラーの返信

シンプルなエラーメッセージをJSON形式で返します。

_json_wp_die_handler( 'エラーが発生しました。' );

例2:WP_Errorオブジェクトの使用

WP_Errorオブジェクトを渡してエラーを処理します。

_json_wp_die_handler( new WP_Error( 'invalid_request', '無効なリクエストです。' ) );

例3:カスタムHTTPステータスコードの設定

エラー応答にカスタムHTTPステータスコードを設定します。

_json_wp_die_handler( 'ページが見つかりません。', '', array( 'response' => 404 ) );

例4:エラータイトルの追加

エラーメッセージとタイトルを指定します。

_json_wp_die_handler( 'データベース接続エラー', '致命的なエラー' );

例5:複数のエラーメッセージを含むWP_Error

複数のエラーメッセージを持つWP_Errorオブジェクトを処理します。

$error = new WP_Error();$error->add( 'error1', 'エラー1' );$error->add( 'error2', 'エラー2' );_json_wp_die_handler( $error );

例6:カスタムヘッダーの追加

エラー応答にカスタムヘッダーを含めます。

_json_wp_die_handler( 'アクセス拒否', '', array( 'headers' => array( 'X-Custom-Header' => 'Value' ) ) );

例7:デバッグモードでの使用

デバッグ情報を含むエラー応答を返します。

_json_wp_die_handler( 'デバッグ情報', '', array( 'debug' => true ) );

注意点

  • この関数は主に内部処理用であり、直接呼び出す場合は注意が必要です。
  • フロントエンドではなくAPIエンドポイントで使用することを想定しています。
  • セキュリティ上、ユーザーに表示するエラーメッセージは適切にフィルタリングしてください。

関連機能：