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

お勧め

プラグインのロード順を制御する（2014年6月9日 更新）

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化：カスタムフィールドキーの条件指定が使いやすくなる（2019年11月19日 更新）

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する（2019年5月14日 更新）

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた（2018年5月27日 更新）

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。