wp_send_json_success

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

説明

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

パラメータ

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

返り値

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

注意

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

/* $dataが省略された場合 */
array( 'success' => true );

/* $dataが指定された場合 */
array( 'success' => true, 'data' => $data );

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

使用例

  • 成功レスポンスを返す。
    <?php wp_send_json_success(); ?>
  • 変数$dataを添えて成功レスポンスを返す。
    <?php wp_send_json_success( $data ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/functions.php

関連

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

参考

Code Reference: wp_send_json_success

お勧めコンテンツ

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 登録）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない（2015年3月15日 登録）

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

投稿内容に応じてwpautopを制御する（2013年8月13日 登録）

投稿内容を表示するthe_content関数では、wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

タイトルが一致する投稿を検索する（2014年2月20日 登録）

WordPressが提供する投稿ページの文字列検索機能の実現には、query_posts関数（WP_Queryクラス）が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数（WP_Queryクラス）の使用法の一例である。

投稿日の検索が自由自在に（2013年10月30日 登録）

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス（もちろんquery_posts関数でも）で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

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