is_wp_error()

Définition : is_wp_error() est une fonction WordPress qui détermine si une valeur est une instance de la classe WP_Error. Elle permet de reconnaître une réponse signalant une erreur avant d’en consulter les détails.

Terminologie

Appellation officielle : is_wp_error()

Autres appellations : Détection WP_Error, Test d’erreur WordPress

Comprendre le fonctionnement

De nombreuses API WordPress utilisent un retour de type WP_Error pour transporter un code, un message et parfois des données complémentaires. is_wp_error() vérifie le type d’une valeur et retourne un booléen. Cela permet d’employer une même structure de traitement d’échec pour différentes opérations de création, lecture ou communication.

La fonction ne garantit pas que l’objet contient effectivement un message d’erreur ; elle vérifie uniquement sa classe. La méthode WP_Error::has_errors() répond à la question du contenu. Il faut également traiter séparément d’autres retours d’échec possibles selon l’API, notamment false ou null : is_wp_error() ne remplace pas la lecture du contrat de retour.

Exemple concret

Après une insertion de contenu, un développeur distingue la réussite d’un éventuel objet WP_Error avant d’afficher une réponse.

Exemple de code commenté

<?php
$resultat = new WP_Error( 'demo', 'Exemple de message.' );
if ( is_wp_error( $resultat ) ) {
    error_log( $resultat->get_error_message() );
}
// Aucun contenu n’est modifié par cet exemple.

Point technique à retenir

Tester le type et inspecter le message sont deux opérations différentes.

Termes associés

  • WP_Error
  • WP_Error::has_errors()
  • WP_Error::get_error_message()

Références officielles

Bouton retour en haut de la page