WP_Error::get_error_data()

Définition : WP_Error::get_error_data() est une méthode qui récupère les données supplémentaires associées à un code d’erreur WordPress. Elle retourne la donnée la plus récemment ajoutée pour ce code, ou null si elle est absente.

Terminologie

Appellation officielle : WP_Error::get_error_data()

Autres appellations : Données associées à l’erreur, Error Data

Comprendre le fonctionnement

Un objet WP_Error peut contenir davantage qu’un message : un code, une donnée technique et d’éventuels détails structurés. get_error_data() permet de consulter les informations associées à un code particulier ; sans code précisé, la méthode examine le premier code disponible. Le type de retour dépend de la donnée enregistrée, et n’est pas nécessairement une chaîne.

Des données d’erreur peuvent inclure un statut HTTP ou une information destinée à la logique applicative. Elles ne sont pas automatiquement appropriées à l’affichage public. Une extension doit contrôler leur structure avant de les utiliser, et éviter d’y stocker des secrets. Pour récupérer l’historique des données d’un code, get_all_error_data() répond à un autre besoin.

Exemple concret

Une API prépare une erreur avec un statut HTTP destiné à un contrôleur, puis le contrôleur consulte cette donnée.

Exemple de code commenté

<?php
$erreur = new WP_Error( 'refus', 'Action non autorisée.', array( 'status' => 403 ) );
$donnees = $erreur->get_error_data( 'refus' );
if ( is_array( $donnees ) && isset( $donnees['status'] ) ) {
    $statut = (int) $donnees['status'];
}