説明
void wp_send_json_error( [ mixed $response = null [ , int $status_code = null [ , int $options = 0 ] ] ] )
AJAXリクエストの失敗レスポンスとしてJSON情報を返す。
パラメータ
- $dataデータ内容を指定（省略時は、null）。
- $status_code[4.7.0]HTTPステータスコードを指定（省略時はnull）。
- $options[5.6.0]json_encode関数の第2パラメータを指定（省略時は0）。
返り値
この関数内で終了するため、何も返さない。注意
レスポンスの内容は、次の通り。
/* $dataが省略された場合 */
array( 'success' => false );
/* $dataが指定された場合 */
array( 'success' => false, 'data' => $data );
[4.1.0]パラメータ$dataがWP_Errorオブジェクトの場合、'data'には$dataがそのまま格納されず、中身であるエラーコード（キー:'code'）とエラーメッセージ（キー:'message'）が格納された配列となる。
[4.7.0]パラメータ$status_codeが指定された場合は先にステータスヘッダーを出力してからJSON内容を出力する。
[5.6.0]パラメータ$optionsはPHPのjson_encode関数の第2パラメータに引き継がれる。値はJSON_FORCE_OBJECT、JSON_HEX_QUOT、JSON_HEX_TAG、JSON_HEX_AMPなどの組み合わせとなる。
使用例
- 失敗レスポンスを返す。<?php wp_send_json_error(); ?>
- 変数$dataを添えて失敗レスポンスを返す。<?php wp_send_json_error( $data ); ?>
フィルター
実行するフィルターはありません。アクション
実行するアクションはありません。ソースファイル
/wp-includes/functions.php最終更新 : 2020年12月10日 10:44
関連
お勧め
Posts filter multiselect：プラグイン作ってみました（2022年4月8日 更新）
先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）
query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？Contact Form 7に確認フェーズを（2012年12月16日 更新）
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。古めのリビジョンを削除した時のメモ（2022年5月16日 更新）
大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。
プラグインで注意が必要な関数（2013年11月27日 更新）
先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。