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

お勧めコンテンツ

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 登録)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

コメントの「ウェブサイト」止めました(2014年4月14日 登録)

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

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

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

購読者は管理者ページのアクセス禁止(2013年11月12日 登録)

購読者(subscriber)は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。

テーマから投稿画像のサイズを指定する(2012年3月15日 登録)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

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