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

説明

wp_send_json_success() は、成功を表すJSON（success: true）を出力して処理を終了する関数です。

基本構文

wp_send_json_success( mixed $value = null, int $status_code = null, int $flags = 0 ): void

引数

  • $value：data として返す値
  • $status_code：HTTPステータス
  • $flags：JSONのフラグ

戻り値

戻り値はありません。

使い方（サンプル）

wp_send_json_success( array( 'message' => '保存しました' ) );

注意点

  • フロント側では、response.success と response.data で受け取ります。

実務での使いどころ

  • Ajaxの処理が、成功したことを、JSONでJavaScriptへ返すとき。

よくあるミスと対処

  • この関数のあとに、処理を書いている。JSONを出力したあと、処理が終了するため、後ろのコードは実行されない。
  • JavaScript側で、response.data ではなく、response を、そのまま使っている。値は、data の中に入る。

NG例

wp_send_json_success( 'OK' );
cleanup(); // 実行されない

OK例

cleanup();
wp_send_json_success( array( 'message' => 'OK' ) );
// JavaScript側： response.data.message

使い分け早見表

関数 出力する形式
wp_send_json_success() {"success":true,"data":...} の形式で出力する
wp_send_json_error() {"success":false,"data":...} の形式で出力する
wp_send_json() 渡した値を、そのままJSONで出力する

関連項目

wp_send_json_error()、wp_send_json()

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

コメント

タイトルとURLをコピーしました