wp_send_json_error

（3.5.0以降）
wp_send_json_error - Ajaxリクエストの失敗レスポンスとしてJSON情報を返す

説明

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

関連

参考

Code Reference: wp_send_json_error

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。