wp_send_json_success()

Définition : wp_send_json_success() renvoie une réponse JSON WordPress indiquant le succès d’une opération. Elle ajoute une propriété success valant true et peut inclure des données ainsi qu’un statut HTTP explicite.

Terminologie

Terme officiel : wp_send_json_success()

Autres appellations : Réponse AJAX positive

À quoi cela sert

Elle unifie les réponses des actions AJAX afin que le navigateur puisse distinguer clairement un traitement réussi et exploiter les informations renvoyées.

Comment cela fonctionne

La fonction construit un objet JSON, configure les en-têtes appropriés dans le contexte prévu, envoie la réponse et termine le traitement. Il n’est donc pas nécessaire d’appeler wp_die() après elle.

Dans quel contexte l’utiliser

À appeler depuis un endpoint AJAX après avoir terminé les vérifications et le travail attendu.

Exemple concret

Un contrôle de disponibilité interne doit retourner un état lisible par le JavaScript d’administration.

Exemple de code commenté

Extrait pédagogique PHP pour extension WordPress : adapter au contexte et tester sur un environnement de développement avant tout usage.

<?php
add_action( 'wp_ajax_atoolpha_demo_resultat', function () {
    check_ajax_referer( 'atoolpha_demo_resultat', 'nonce' );
    if ( ! current_user_can( 'manage_options' ) ) {
        wp_send_json_error( array( 'message' => 'Interdit' ), 403 );
    }
    wp_send_json_success( array( 'message' => 'Contrôle terminé' ), 200 );
} );

Explication pas à pas de l’exemple

1. Le callback contrôle le nonce et les droits. 2. Il construit un tableau de données non sensibles. 3. La fonction génère success=true et data. 4. L’exécution du handler s’arrête.

Résultat attendu

Le navigateur reçoit une réponse JSON de succès contenant le message de confirmation et un code HTTP 200.

Mise en pratique guidée

Faire répondre un endpoint AJAX de démonstration après tous les contrôles. Dans le navigateur, examiner success=true, data.message et le statut HTTP. Ajouter ensuite un échec métier volontaire avant l’appel : la réponse ne doit plus annoncer un succès. Ce test rappelle qu’une réponse JSON favorable décrit un résultat acquis, et non une opération simplement envisagée.

Précautions et limites

Le succès applicatif doit correspondre à la réalité de l’opération : ne pas retourner true avant une écriture ou une vérification qui pourrait échouer. Ne pas renvoyer de secrets dans data.