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

お勧めコンテンツ

add_actionを使って管理ページで独自cssを使う(2011年2月25日 登録)

テーマやプラグインで専用の管理ページを作る場合、そのページ向けのcssやjavascriptが必要になることがある。どちらもページ内に直接記述できるが、特にcssは別ファイルに分けたいほうが便利だ。ここではその方法を紹介しよう。

メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 登録)

この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。

headタグのmeta(generator)タグを取り除く(2011年2月18日 登録)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

get_postsとquery_postsを使い分け(2011年1月21日 登録)

get_postsquery_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

各種リンクを取得する関数一覧(2014年6月12日 登録)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

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