WP_Error

Définition : WP_Error est une classe WordPress servant à représenter une ou plusieurs erreurs avec leurs codes, messages et données associées. Elle permet aux fonctions et extensions de retourner des échecs de manière structurée.

Terminologie

Appellation / équivalent : WP_Error — WordPress Error class

Autres appellations : Objet d’erreur WordPress

Comprendre le fonctionnement

Une instance de WP_Error peut conserver plusieurs codes d’erreur, chacun accompagné de messages et, si nécessaire, de données complémentaires. Des fonctions du Core renvoient un objet de ce type lorsqu’une opération échoue.

Avant d’utiliser une valeur retournée par une API susceptible de produire WP_Error, il faut vérifier son type avec is_wp_error(). La méthode get_error_message() permet ensuite de récupérer un message approprié au traitement attendu.

Exemple concret

Lorsqu’une validation échoue, un plugin peut retourner un objet d’erreur plutôt qu’une simple chaîne difficile à distinguer d’un résultat normal.

Exemple de code commenté

<?php
// Exemple dans une fonction exécutée par WordPress.
function atoolpha_verifier_reference( $reference ) {
    if ( '' === trim( $reference ) ) {
        return new WP_Error(
            'reference_vide',
            'La référence ne peut pas être vide.'
        );
    }
    return $reference;
}

$resultat = atoolpha_verifier_reference( '' );
if ( is_wp_error( $resultat ) ) {
    // Traitement de l'erreur selon le contexte de l'application.
    $message = $resultat->get_error_message();
}