説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日 更新）
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo：プラグイン作ってみました（2019年9月19日 更新）
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。