説明
パラメータ
- $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
関連
お勧め
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を(2013年11月6日 更新)
WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。