CKTIS / PHP
Exception::getMessage — lire le message d’une exception
Lisez le message d’une exception interceptée, distinguez-le du code et de la trace de la pile, puis décidez quoi consigner et quoi afficher à l’utilisateur.
Version : PHP 8.3; extension availability may vary
Syntaxe
final public function getMessage(): string
$e->getMessage()Exception::getMessage renvoie le message d’un objet d’exception sous forme de string. C’est une méthode d’instance publique sans argument ; final signifie que les sous-classes ne peuvent pas la redéfinir. :: désigne la classe dans le nom de la méthode ; pour appeler celle-ci sur l’objet, utilisez -> : $e->getMessage(). En PHP 8.3, cet appel sur new \Exception() sans message renvoie la chaîne vide ''.
catch (\Exception $e) intercepte les objets \Exception et ceux de ses sous-classes, mais pas les objets \Error. Pour traiter les deux hiérarchies, utilisez catch (\Throwable $e) : l’interface commune fournit aussi getMessage(). Cela n’intercepte pas les avertissements ordinaires qui ne sont pas levés sous forme d’objets. Le \ initial désigne le nom global, même dans un espace de noms.
getMessage() ne renvoie ni le code ni la trace de la pile ; utilisez respectivement getCode() et getTrace(). Le message de l’exception précédente n’est pas inclus non plus. Récupérez l’objet précédent avec getPrevious() et vérifiez que le résultat n’est pas null avant d’appeler getMessage() dessus.
Ne faites pas dépendre la logique du programme du libellé du message. Utilisez plutôt un type d’exception ou un code dont la signification est documentée. En production, n’affichez pas les messages d’exception bruts : ils peuvent contenir des chemins ou des données sensibles. Affichez un message sans risque et ne consignez que des détails de diagnostic dont les données sensibles ont été retirées.
Exemples
<?php
try {
$cause = new \Exception('Invalid row format');
throw new \Exception('Import failed', previous: $cause);
} catch (\Exception $e) {
echo $e->getMessage(), "\n";
$previous = $e->getPrevious();
if ($previous !== null) {
echo $previous->getMessage(), "\n";
}
}Résultat
Import failed Invalid row format
La première ligne affiche le message de l’exception interceptée. La seconde n’apparaît que parce que le code récupère l’objet précédent et appelle séparément `getMessage()` dessus.
Leçons associées
- PHP · Leçon 41 · Avancé · Version : 2
- PHP · Leçon 67 · Avancé · Version : 2
- PHP · Leçon 68 · Avancé · Version : 2
- PHP · Leçon 69 · Avancé · Version : 2
- PHP · Leçon 70 · Avancé · Version : 2
- PHP · Leçon 75 · Avancé · Version : 2
- PHP · Leçon 82 · Avancé · Version : 2
- PHP · Leçon 20 · Intermédiaire · Version : 3