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情報を返す

お勧めコンテンツ

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 登録)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

Login rebuilderで第2ログインページのURLを取得する(2015年5月24日 登録)

先週のこと、「Login rebuilder」のユーザから「wp_login_url関数のように第2ログインページのURLを取得できないか」という問い合わせがありました。その時点ではそのような関数やメソッドを用意していなかったのですが、まあニーズがあるなら作ってみようと思い、対応するメソッドを追加したLogin rebuilderバージョン1.4.3をリリースしました。

各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 登録)

投稿記事ごとに設定されているカスタムフィールドの値はget_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。

管理者ページに文言を表示する(2012年4月19日 登録)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

絵文字画像がPNGからSVGへ(2016年8月15日 登録)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

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