wp_send_json

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

説明

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

パラメータ

  • $response
    レスポンス内容を指定。
  • $status_code
    [4.7.0]HTTPステータスコードを指定(省略時はnull)。

返り値

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

注意

実際のJSONデータを出力する前にコンテントタイプヘッダー情報を送信している。その中のcharsetの内容は、get_option( 'blog_charset' ) で取得している。

[4.7.0]パラメータ$status_codeが指定された場合は先にステータスヘッダーを出力してからJSON内容を出力する。

使用例

  • 変数$resultをレスポンスとして返す。
    <?php wp_send_json( $result ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/functions.php

関連

  • get_option - オプションの値を取得する
  • status_header - HTTPステータスをセットする
  • wp_die - エラーメッセージを表示する
  • wp_json_encode - データをJSON形式にエンコードする
  • wp_send_json_error - Ajaxリクエストの失敗レスポンスとしてJSON情報を返す
  • wp_send_json_success - Ajaxリクエストの成功レスポンスとしてJSON情報を返す
  • DOING_AJAX - AJAXのレスポンス処理中の判定

お勧めコンテンツ

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 登録)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

WordPressの鼓動(2013年10月1日 登録)

WordPressでは、Ajaxを利用する方法の1つとしてadd_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

プラグインで注意が必要な関数(2013年11月27日 登録)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

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

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

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

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

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