WP_Error::add()

Définition : WP_Error::add() est une méthode qui ajoute un code, un message et éventuellement des données à un objet WP_Error. Elle sert à accumuler plusieurs informations d’échec dans une représentation structurée.

Terminologie

Appellation / équivalent : WP_Error::add — ajout d’un élément d’erreur

Autres appellations : Ajout de code d’erreur, Enrichissement d’un objet WP_Error

Comprendre le fonctionnement

La méthode accepte un code textuel, un message et des données facultatives. Plusieurs messages peuvent partager un même code ; WP_Error conserve ces informations pour que le code appelant puisse les consulter. Elle intervient notamment dans les validations où plusieurs problèmes doivent être remontés ensemble.

Une erreur WP_Error n’émet pas automatiquement une réponse HTTP ni un message visible à l’écran. C’est au code appelant de décider comment traiter ou présenter cette information. Les données d’erreur ne doivent pas recevoir de secrets qu’un affichage ultérieur pourrait exposer. Pour connaître les messages, utiliser les méthodes de lecture et vérifier l’existence de l’objet.

Exemple concret

Un formulaire d’administration peut regrouper plusieurs anomalies de validation avant de produire un retour exploitable par son gestionnaire.

Exemple de code commenté

<?php
// Exemple pédagogique : accumulation de deux erreurs.
$erreurs = new WP_Error();
$erreurs->add( 'champ_manquant', 'Le titre est obligatoire.' );
$erreurs->add( 'format_invalide', 'La référence est invalide.' );
if ( $erreurs->has_errors() ) {
    foreach ( $erreurs->get_error_messages() as $message ) {
        echo '<p>' . esc_html( $message ) . '</p>';
    }
}

Point technique à retenir

Ajouter une erreur à un objet ne provoque pas automatiquement l’arrêt du traitement ; le code appelant doit gérer la suite.

Termes associés

  • WP_Error
  • WP_Error::get_error_message()
  • WP_Error::get_error_codes()
  • is_wp_error()

Références officielles

Bouton retour en haut de la page