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

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

作成日: 2025年09月11日更新日: 2025年10月14日

基本的な使い方

getMessageメソッドは、エラーや例外が発生した際に、そのエラーに関する詳細なメッセージを取得するメソッドです。

このメソッドが所属するArithmeticErrorクラスは、PHPにおいて算術演算に起因するエラー（例えば、ゼロによる除算や数値が扱える範囲を超えた場合など）を表すために用いられます。ArithmeticErrorは、プログラムの実行中に発生する可能性のある深刻な問題の一つであり、基本的なErrorクラスの派生クラスとして定義されています。

getMessageメソッドは、ArithmeticErrorオブジェクトから具体的なエラー内容を文字列として取り出すために利用されます。例えば、try-catchブロックで算術エラーを捕捉した場合、catchブロック内でこのメソッドを呼び出すことで、「ゼロで割ることはできません」といった、エラーの具体的な説明文を取得することができます。

取得されたメッセージは、開発者がプログラムのどこで、どのような種類の問題が発生したのかを把握し、デバッグ作業を進める上で非常に重要な情報源となります。また、エンドユーザーに対してエラー内容を分かりやすく提示する際にも活用できます。getMessageメソッドは、PHPの堅牢なエラーハンドリングにおいて、エラーの状況を把握するための基本的な手段として広く用いられています。

構文(syntax)


1<?php
2
3try {
4    // ArithmeticError を発生させる操作 (例: 0による除算)
5    $result = intdiv(10, 0);
6    echo "結果: " . $result;
7} catch (ArithmeticError $e) {
8    // 捕捉した ArithmeticError オブジェクトからエラーメッセージを取得する
9    echo $e->getMessage();
10}
11
12?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

ArithmeticErrorクラスのgetMessageメソッドは、エラーが発生した際にその詳細を表す文字列を返します。

サンプルコード

PHP ArithmeticErrorメッセージの短縮（truncate）


1<?php
2
3/**
4 * ArithmeticErrorを捕捉し、そのメッセージを短縮して表示するサンプル関数
5 *
6 * この関数は、意図的にビットシフト演算でArithmeticErrorを発生させ、
7 * try-catchブロックで捕捉します。
8 * catchブロック内では、getMessage()メソッドでエラーメッセージを取得し、
9 * 長いメッセージをログ記録などのために短縮（truncate）する例を示します。
10 */
11function demonstrateTruncatedErrorMessage(): void
12{
13    try {
14        // 負のビット数でシフトすると ArithmeticError がスローされる
15        $value = 1 << -1;
16    } catch (ArithmeticError $e) {
17        // getMessage() を使ってエラーメッセージ全体を取得する
18        $fullMessage = $e->getMessage();
19        echo "Original message:\n";
20        echo $fullMessage . "\n\n";
21
22        // メッセージが30文字より長い場合、省略記号をつけて短縮（truncate）する
23        $maxLength = 30;
24        $truncatedMessage = mb_strimwidth($fullMessage, 0, $maxLength, '...');
25
26        echo "Truncated message:\n";
27        echo $truncatedMessage . "\n";
28    }
29}
30
31// 関数を実行して結果を確認します
32demonstrateTruncatedErrorMessage();

このサンプルコードは、PHPで算術演算に関するエラー（ArithmeticError）が発生した際に、そのエラーメッセージを取得し、表示用に短縮する方法を示しています。

tryブロック内では、負の数によるビットシフト演算 (1 << -1) を意図的に実行しています。PHP 8以降、この操作はArithmeticErrorという例外を発生させます。catchブロックは、この発生したArithmeticErrorを捕捉し、エラー情報を持つ例外オブジェクトを引数$eとして受け取ります。

ここで使われているgetMessage()メソッドは、捕捉した例外オブジェクト$eが持つメソッドです。このメソッドは引数を取らず、エラーの具体的な内容を説明する文字列を戻り値として返します。コードでは、まずgetMessage()で取得した元のエラーメッセージをそのまま表示しています。次に、ログへの記録などで長いメッセージを簡潔にしたい場合を想定し、mb_strimwidth関数を使って文字列を30文字に短縮（truncate）し、末尾に省略記号「...」を付加して表示しています。このようにgetMessage()を利用することで、発生したエラーの詳細をプログラムで取得し、柔軟に処理することができます。

getMessageメソッドで取得できるエラーメッセージは、PHPのバージョンや設定によって内容が変わる可能性があります。そのため、メッセージの特定の文言に依存する処理は避けるべきです。例外を捕捉する際は、サンプルのようにArithmeticErrorなど、想定される具体的なエラークラスをcatchで指定することが推奨されます。これにより、予期せぬ他のエラーまで捕捉してしまうことを防ぎ、問題の特定が容易になります。また、ログ出力などでメッセージを短縮する場合、mb_strimwidth関数を使うと日本語などのマルチバイト文字も文字化けせずに安全に扱えます。