wp_send_json_success()


WordPressのwp_send_json_success()関数は、JSON形式の成功レスポンスを送信するために使用されます。

構文

wp_send_json_success( mixed $data = null, int $status_code = null );

引数の説明:

  • $data (mixed) — 成功レスポンスに含めるデータ。省略可能。
  • $status_code (int) — HTTPステータスコード。省略可能。

例 1: 基本的な使用例

シンプルな成功レスポンスを返します。

<?php wp_send_json_success(); ?>

例 2: データを含むレスポンス

データを含めたJSONレスポンスを返します。

<?php
$data = array( 'message' => '操作が成功しました。' );
wp_send_json_success( $data );
?>

例 3: ステータスコードを指定したレスポンス

成功レスポンスにHTTPステータスコードを指定します。

<?php
$data = array( 'message' => 'リクエストは正常に処理されました。' );
wp_send_json_success( $data, 201 );
?>

例 4: Ajaxリクエストでの使用

Ajaxリクエストに対して成功レスポンスを返します。

<?php
add_action( 'wp_ajax_my_action', function() {
    $data = array( 'result' => 'success' );
    wp_send_json_success( $data );
} );
?>

例 5: 複雑なデータを含むレスポンス

多次元配列をデータとしてレスポンスに含めます。

<?php
$data = array(
    'user' => array(
        'id' => get_current_user_id(),
        'name' => wp_get_current_user()->display_name,
    ),
    'status' => 'active'
);
wp_send_json_success( $data );
?>

注意事項

  • wp_send_json_success()を使用すると、スクリプトの実行が停止します。
  • 複数のレスポンスを返す必要がある場合、使用は避けてください。
  • セキュリティを考慮し、必要以上のデータをレスポンスに含めないようにしてください。

関連機能：