【PHP8.x】getMessageメソッドの使い方

getMessageメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getMessageメソッドは、スローされた例外オブジェクトに設定されているエラーメッセージ文字列を取得するために実行するメソッドです。このメソッドは、LogicExceptionクラスが属するExceptionクラスから継承されたものであり、PHPの多くの標準例外クラスで共通して利用できます。プログラムの実行中に例外がスローされると、try...catchブロックでその例外オブジェクトを捕捉できます。捕捉したオブジェクトに対してこのメソッドを呼び出すことで、例外が発生した原因を示す具体的なメッセージを得ることが可能です。メッセージの内容は、通常、throw new LogicException('ここにエラーメッセージを指定');のように、例外オブジェクトが生成される際のコンストラクタの第一引数で指定された文字列となります。取得したエラーメッセージは、主にデバッグ時の原因調査や、ログファイルへのエラー内容の記録、あるいはユーザーへの通知などに活用されます。返り値はstring型で、例外発生時にどのような問題が起きたのかを把握するための重要な情報を提供します。

構文(syntax)

1final public getMessage(): string

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

例外が発生した際に、その例外がどのようなエラーメッセージを示しているのかを文字列として返します。