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

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

作成日: 2025年09月11日更新日: 2025年12月17日

基本的な使い方

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プロパティは、例外が発生した理由を示す文字列を返します。

サンプルコード

PHP例外メッセージボックスを表示する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * 2つの数値を割り算する。
7 * 割る数が0の場合は、引数が不正であるとして例外をスローする。
8 *
9 * @param int $numerator   分子
10 * @param int $denominator 分母
11 * @return float           計算結果
12 * @throws InvalidArgumentException 割る数が0の場合
13 */
14function calculateDivision(int $numerator, int $denominator): float
15{
16    if ($denominator === 0) {
17        // 例外オブジェクトを生成し、コンストラクタにメッセージを渡す
18        throw new InvalidArgumentException('エラー: 0で割ることはできません。');
19    }
20    return $numerator / $denominator;
21}
22
23// HTML文書の開始
24echo <<<HTML
25<!DOCTYPE html>
26<html lang="ja">
27<head>
28    <meta charset="UTF-8">
29    <title>PHP Exception Message Box Example</title>
30</head>
31<body>
32HTML;
33
34try {
35    // 意図的に例外を発生させるために、0で割り算を実行
36    echo "<p>5を0で割ろうとしています...</p>";
37    $result = calculateDivision(5, 0);
38    echo "<p>計算結果: {$result}</p>";
39
40} catch (InvalidArgumentException $e) {
41    // 例外を捕捉(catch)する
42    // InvalidArgumentExceptionオブジェクトの`message`プロパティの値をgetMessage()で取得
43    $errorMessage = $e->getMessage();
44
45    // 取得したエラーメッセージをJSON形式にエンコードし、
46    // JavaScriptの文字列リテラルとして安全に埋め込めるようにする
47    $jsonMessage = json_encode($errorMessage, JSON_HEX_TAG | JSON_HEX_APOS);
48
49    // 取得したエラーメッセージをJavaScriptのalert()（メッセージボックス）で表示する
50    echo <<<JS
51    <script>
52        alert({$jsonMessage});
53    </script>
54JS;
55
56    echo "<p>例外が捕捉され、メッセージボックスが表示されました。</p>";
57}
58
59// HTML文書の終了
60echo <<<HTML
61</body>
62</html>
63HTML;

このPHPサンプルコードは、関数の引数が不正な場合に発生するInvalidArgumentExceptionを捕捉し、そのエラーメッセージをWebブラウザのメッセージボックスで表示する例です。

まず、calculateDivision関数は2つの数値を割り算しますが、分母が0の場合は計算ができないため、new InvalidArgumentException()を用いて例外を意図的に発生（スロー）させます。このとき、コンストラクタに渡された「エラー: 0で割ることはできません。」という文字列が、例外オブジェクトのmessageプロパティに格納されます。

次に、tryブロック内でこの関数を呼び出し、意図的に例外を発生させます。発生した例外はcatchブロックで捕捉されます。捕捉したInvalidArgumentExceptionオブジェクト（変数$e）からgetMessage()メソッドを呼び出すことで、messageプロパティに保存されているエラーメッセージ文字列を取得できます。getMessage()メソッドは引数を取らず、戻り値としてstring型のメッセージを返します。

最後に、取得したエラーメッセージをJavaScriptのalert()関数に渡して実行することで、ブラウザ上にメッセージボックスとして表示しています。このように、例外のmessageプロパティを利用することで、エラー発生時の具体的な理由をユーザーに伝えることができます。

このコードは、関数の引数が不正な場合に発生する例外を捕捉し、そのメッセージをブラウザに表示する例です。エラーが起こりうる処理をtryブロックで囲み、catchブロックでエラー発生時の処理を記述します。catchで受け取った例外オブジェクト（$e）からエラーメッセージを取得するにはgetMessage()メソッドを使います。このメッセージは、例外を発生させた時に指定した文字列です。特に重要なのは、PHPの変数をJavaScriptに渡す際のセキュリティ対策です。json_encode関数で文字列を処理することで、意図しないスクリプト実行（XSS）を防いでいます。これはWeb開発で必須の知識です。実際の運用では、メッセージボックスで表示するだけでなく、エラー内容をログファイルに記録することも一般的です。

PHPでメッセージキューを実装し、例外処理を行う


1<?php
2
3declare(strict_types=1);
4
5/**
6 * メッセージキューを簡易的に模倣するクラス。
7 *
8 * このクラスは、タスク（メッセージ）を一時的に保管し、
9 * 後から順番に取り出して処理するキューの基本的な機能を提供します。
10 */
11class SimpleMessageQueue
12{
13    /** @var string[] キューに格納されたメッセージの配列 */
14    private array $queue = [];
15
16    /**
17     * キューにメッセージを追加します。
18     *
19     * メッセージが空文字列や空白のみの場合、引数が不正とみなし、
20     * InvalidArgumentExceptionをスローします。
21     *
22     * @param string $message 送信するメッセージ
23     * @throws InvalidArgumentException メッセージが空の場合
24     */
25    public function sendMessage(string $message): void
26    {
27        // 引数として渡されたメッセージが有効かチェック
28        if (trim($message) === '') {
29            // 不正な引数であるため、例外をスローする
30            // このとき設定したエラー文が 'message' プロパティに格納される
31            throw new InvalidArgumentException('メッセージを空にすることはできません。');
32        }
33
34        $this->queue[] = $message;
35        echo "メッセージを追加しました: '{$message}'" . PHP_EOL;
36    }
37
38    /**
39     * キューの先頭からメッセージを1つ取り出します。
40     *
41     * @return string|null メッセージ、またはキューが空の場合はnull
42     */
43    public function receiveMessage(): ?string
44    {
45        // 配列の先頭から要素を取り出す (First-In, First-Out)
46        return array_shift($this->queue);
47    }
48}
49
50// メッセージキューのインスタンスを作成
51$messageQueue = new SimpleMessageQueue();
52
53try {
54    // 正常なメッセージをキューに追加する
55    $messageQueue->sendMessage('Task A: ユーザープロフィール更新');
56    $messageQueue->sendMessage('Task B: 請求書メール送信');
57
58    // 不正な引数（空のメッセージ）を送信し、意図的に例外を発生させる
59    echo "--- 不正なメッセージを送信しようとします ---" . PHP_EOL;
60    $messageQueue->sendMessage('   '); // 空白のみのメッセージ
61
62} catch (InvalidArgumentException $e) {
63    // sendMessageメソッドでスローされた例外をキャッチする
64    // $e->getMessage() で、例外インスタンスの 'message' プロパティを取得し表示する
65    echo "エラーをキャッチしました: " . $e->getMessage() . PHP_EOL;
66}
67
68echo "--- 残りのメッセージを処理します ---" . PHP_EOL;
69
70// 例外が発生しても、それ以前に追加されたメッセージはキューに残っている
71while (($task = $messageQueue->receiveMessage()) !== null) {
72    echo "メッセージを処理中: '{$task}'" . PHP_EOL;
73    // ここで実際のタスク処理を行う (例: DB更新、メール送信など)
74}
75
76echo "キューの処理が完了しました。" . PHP_EOL;
77

このPHPサンプルコードは、簡易的なメッセージキューの動作を通じて、例外処理における InvalidArgumentException クラスとその message プロパティの使い方を解説します。

SimpleMessageQueue クラスの sendMessage メソッドは、引数として受け取ったメッセージが空文字列や空白のみの場合、不正な引数と判断して InvalidArgumentException という例外を発生させます。このとき、new InvalidArgumentException('メッセージを空にすることはできません。') のように、エラー理由を示す文字列を引数に指定します。この文字列が、生成された例外オブジェクトの message プロパティに保存されます。

try...catch ブロックでは、この例外処理の動作を確認しています。try の中で意図的に不正な引数を渡して例外を発生させると、プログラムの実行は catch ブロックに移ります。ここで、$e->getMessage() というコードが実行されます。getMessage() メソッドは、キャッチした例外オブジェクト（この例では変数 $e）が持つ message プロパティの値を返します。このメソッドに引数はなく、戻り値は例外生成時に設定されたエラーメッセージの文字列（string）です。

このように、message プロパティと getMessage() メソッドを使うことで、例外発生時にその具体的な原因をプログラムの利用者に伝え、デバッグやエラー対応を容易にすることができます。

InvalidArgumentExceptionは、メソッドに不正な引数が渡されたことを示すためのエラーです。サンプルコードのsendMessageメソッドでは、空のメッセージが渡されるとこの例外をスローします。例外が発生するとプログラムは停止してしまいますが、try...catch構文で処理を囲むことで、エラーを捕捉し、プログラムの続行が可能です。catchブロックで受け取った例外オブジェクトのgetMessage()メソッドを使うと、throwされた際に設定された具体的なエラー内容を取得できます。このように、メソッドの入口で引数の妥当性を検証し、問題があれば例外を発生させることは、安全なプログラムを作る上で非常に重要です。