wp_send_json_error

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

説明

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

関連

  • status_header - HTTPステータスをセットする
  • wp_send_json - AjaxリクエストのレスポンスとしてJSON情報を返す
  • wp_send_json_success - Ajaxリクエストの成功レスポンスとしてJSON情報を返す

お勧めコンテンツ

使っていないか確認しないとね!(2011年6月8日 登録)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

Emojin:プラグイン作ってみました(2014年8月23日 登録)

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

パスとURL(2011年10月6日 登録)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

WP_List_Tableクラスを使ってみた(2017年8月23日 登録)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

canvasタグを投稿したい(2013年12月27日 登録)

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。

最終更新日時 : 2016-12-09 10:42