【PHP8.x】messageプロパティの使い方

messageプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

messageプロパティは、例外に関する詳細な説明文を保持するプロパティです。このプロパティは、InvalidArgumentExceptionクラスのインスタンスが生成される際に、コンストラクタの第一引数として渡されたエラーメッセージの文字列を格納します。InvalidArgumentExceptionは、関数やメソッドに渡された引数の型や値が期待されるものと異なっていた場合にスローされる例外です。messageプロパティには、なぜその引数が無効であったかを示す、開発者が理解しやすい具体的な理由が設定されます。このプロパティはprotectedとして宣言されているため、クラスの外部から直接アクセスすることはできません。値を取得するためには、公開されているgetMessage()メソッドを使用する必要があります。try-catch構文で例外を捕捉した際、開発者はこのgetMessage()メソッドを呼び出してエラーメッセージを取得し、ログに記録したり、デバッグ時の原因特定の手がかりとして利用したりします。このプロパティは、基底クラスであるExceptionクラスから継承されたものであり、PHPにおける例外処理の基本的な仕組みの一部を担っています。

構文(syntax)

1<?php
2
3try {
4    throw new InvalidArgumentException("無効な引数が指定されました。");
5} catch (InvalidArgumentException $e) {
6    // 例外オブジェクトの message プロパティにアクセスするための public メソッド
7    echo $e->getMessage();
8}
9
10?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

InvalidArgumentExceptionクラスのmessageプロパティは、例外が発生した理由を示す文字列を返します。

関連コンテンツ

関連プログラミング言語