wp_send_json_success

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

説明

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

パラメータ

  • $data
    データ内容を指定（省略時は、null）。
  • $status_code
    [4.7.0]HTTPステータスコードを指定（省略時はnull）。
  • $options
    [5.6.0]json_encode関数の第2パラメータを指定（省略時は0）。

返り値

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

注意

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

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

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

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

[5.6.0]パラメータ$optionsはPHPのjson_encode関数の第2パラメータに引き継がれる。値はJSON_FORCE_OBJECT、JSON_HEX_QUOT、JSON_HEX_TAG、JSON_HEX_AMPなどの組み合わせとなる。

使用例

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

フィルター

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

アクション

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

ソースファイル

/wp-includes/functions.php

最終更新 : 2020年12月10日 10:42

関連

参考

Code Reference: wp_send_json_success

お勧め

パスとURL（2011年10月6日 更新）

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability（2018年5月27日 更新）

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。