wp_send_json_error

説明

void wp_send_json_error( mixed $response, int $status_code = null )
AJAXリクエストの失敗レスポンスとしてJSON情報を返す。

パラメータ

  • $data
    データ内容を指定(省略時は、null)。
  • $status_code
    [4.7.0]HTTPステータスコードを指定(省略時はnull)。

返り値

この関数内で終了するため、何も返さない。

注意

レスポンスの内容は、次の通り。

/* $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内容を出力する。


使用例

  • 失敗レスポンスを返す。
    <?php wp_send_json_error(); ?>
  • 変数$dataを添えて失敗レスポンスを返す。
    <?php wp_send_json_error( $data ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

最終更新 : 2016年12月09日 10:42



お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Login rebuilder 2.4.0の新機能を紹介(2018年5月27日 更新)

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ(author page)の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。