【PHP8.x】set_exception_handler関数の使い方

Copy
1<?php
2
3/**
4 * カスタムの例外ハンドラを提供するクラス。
5 * 未捕獲の例外が発生した際に、このクラスの静的メソッドが呼び出されます。
6 */
7class CustomExceptionHandler
8{
9    /**
10     * 未捕獲の例外を処理する静的メソッド。
11     *
12     * このメソッドは、PHPスクリプト内で `try...catch` ブロックで捕捉されなかった
13     * 例外が発生したときに `set_exception_handler` によって呼び出されます。
14     *
15     * @param Throwable $exception 捕捉された例外オブジェクト。
16     * @return void
17     */
18    public static function handle(Throwable $exception): void
19    {
20        // ここで例外の情報をログに記録したり、ユーザーにエラーページを表示したりします。
21        // システムエンジニアとしては、本番環境では詳細なエラーメッセージを直接表示せず、
22        // ログに記録するだけに留めるのが一般的です。
23        error_log(
24            "Unhandled Exception: " . $exception->getMessage() .
25            " in " . $exception->getFile() .
26            " on line " . $exception->getLine() .
27            "\nStack trace:\n" . $exception->getTraceAsString()
28        );
29
30        // 開発環境では、デバッグのためにエラー情報を出力しても良いでしょう。
31        echo "<h1>システムエラーが発生しました</h1>";
32        echo "<p>申し訳ありませんが、予期せぬエラーが発生しました。</p>";
33        echo "<p>管理者によってログに記録されました。</p>";
34
35        // デバッグ情報 (本番環境では非表示にすべき)
36        echo "<pre>";
37        echo "<strong>Exception Message:</strong> " . htmlspecialchars($exception->getMessage()) . "\n";
38        echo "<strong>File:</strong> " . htmlspecialchars($exception->getFile()) . "\n";
39        echo "<strong>Line:</strong> " . htmlspecialchars($exception->getLine()) . "\n";
40        echo "<strong>Stack Trace:</strong>\n" . htmlspecialchars($exception->getTraceAsString()) . "\n";
41        echo "</pre>";
42
43        // HTTPステータスコードを500 (Internal Server Error) に設定
44        http_response_code(500);
45
46        // 例外ハンドラが処理を終えたら、通常はスクリプトの実行を終了します。
47        exit(1);
48    }
49}
50
51// グローバルな未捕獲例外ハンドラを設定します。
52// ここでは、CustomExceptionHandlerクラスの静的メソッド 'handle' を指定しています。
53set_exception_handler(['CustomExceptionHandler', 'handle']);
54
55echo "スクリプトが開始されました。\n";
56
57// 意図的に例外を発生させて、ハンドラが動作することを確認します。
58// この例外は `try...catch` ブロックで捕捉されていないため、
59// 上記で設定した `CustomExceptionHandler::handle()` が呼び出されます。
60throw new Exception("これはテストのために意図的に発生させた例外です。");
61
62// 上記の例外が発生し、ハンドラが `exit(1)` を呼び出すため、
63// この行以降のコードは実行されません。
64echo "このメッセージは表示されません。\n";
65
66?>

PHPのset_exception_handler関数は、スクリプト内でtry...catchブロックによって捕捉されなかった（未捕捉の）例外が発生した際に、その例外を処理するためのカスタム関数やメソッドを設定します。

引数?callable $callbackには、例外を処理する関数またはクラスの静的メソッドを指定します。サンプルコードでは、CustomExceptionHandlerクラスの静的メソッドhandleが設定されています。このメソッドは、Throwable型の例外オブジェクトを受け取り、未捕捉の例外の詳細情報を取得して処理します。戻り値は、以前に設定されていた例外ハンドラ（存在すれば）を返します。これにより、必要に応じて元のハンドラに戻すことも可能です。

サンプルコードでは、set_exception_handlerによりCustomExceptionHandler::handleメソッドがグローバルな例外ハンドラとして登録されています。意図的に例外を発生させると、このhandleメソッドが呼び出され、例外の詳細がシステムログに記録されます。同時に、ユーザーには一般的なエラーメッセージを表示し、HTTPステータスコードを500（Internal Server Error）に設定した後、スクリプトを終了させます。システムエンジニアとしては、このように本番環境でユーザーに詳細なエラーメッセージを直接表示せず、ログに記録して対応することが重要です。これにより、予期せぬエラー発生時でも、安全にシステムを停止し、エラー情報を収集する仕組みを構築できます。

Copy
1<?php
2
3/**
4 * Custom global exception handler.
5 *
6 * This function is registered using `set_exception_handler()` and will be
7 * called for any uncaught exceptions in the script.
8 * If an exception is caught by a local `try-catch` block, this global handler
9 * will NOT be triggered for that specific exception, which is a common reason
10 * why `set_exception_handler` might appear "not working".
11 *
12 * @param Throwable $exception The uncaught exception object.
13 */
14function myGlobalExceptionHandler(Throwable $exception): void
15{
16    echo "--- GLOBAL EXCEPTION HANDLER ACTIVATED ---\n";
17    echo "An uncaught exception occurred:\n";
18    echo "Type: " . get_class($exception) . "\n";
19    echo "Message: " . $exception->getMessage() . "\n";
20    echo "File: " . $exception->getFile() . "\n";
21    echo "Line: " . $exception->getLine() . "\n";
22    // In a real application, you would typically:
23    // 1. Log the exception details for debugging.
24    // 2. Optionally send an alert to developers.
25    // 3. Display a user-friendly error page (e.g., "Something went wrong").
26    // It's common practice to terminate the script after an uncaught exception.
27    exit(1);
28}
29
30// Register the custom global exception handler.
31// This must be called before any uncaught exceptions are thrown for it to take effect.
32set_exception_handler('myGlobalExceptionHandler');
33
34echo "--- Scenario 1: Exception caught by a local try-catch block ---\n";
35echo "The global exception handler will NOT be triggered here because the exception is handled locally.\n\n";
36
37try {
38    echo "Attempting to throw an exception inside a try-catch block...\n";
39    throw new InvalidArgumentException("This is a locally caught exception.");
40    // This line will not be executed because the exception is thrown above it.
41} catch (InvalidArgumentException $e) {
42    echo "--> Successfully caught by local try-catch block!\n";
43    echo "    Exception Type: " . get_class($e) . "\n";
44    echo "    Message: " . $e->getMessage() . "\n";
45    echo "Local handling complete. Script continues as normal.\n\n";
46    // The global handler was NOT called because this exception was handled within this block.
47}
48
49echo "--- Scenario 2: Uncaught exception ---\n";
50echo "The global exception handler WILL be triggered in this scenario.\n";
51echo "This will be the last output before the global handler takes over and exits the script.\n\n";
52
53// This exception is NOT wrapped in a try-catch block.
54// Therefore, it is "uncaught" and will be passed to the global exception handler
55// that we registered with `set_exception_handler()`.
56throw new RuntimeException("This is an uncaught exception that will trigger the global handler.");
57
58echo "This line will NOT be executed because the script will exit via the global handler above.\n";

set_exception_handler関数は、PHPスクリプト内でtry-catchブロックによって捕捉されなかった「未処理（uncaught）」の例外をグローバルに処理するためのコールバック関数を設定します。引数$callbackには、未処理の例外が発生した際に呼び出される関数を指定し、この関数はThrowable型の例外オブジェクトを受け取ります。戻り値は、以前に設定されていたハンドラ関数、または何も設定されていなかった場合はnullです。

サンプルコードでは、myGlobalExceptionHandler関数をグローバルハンドラとして登録しています。このハンドラは、未処理の例外が発生した場合に、その種類、メッセージ、発生ファイルと行番号を出力し、通常はスクリプトを終了させます。

シナリオ1では、例外がtry-catchブロックによって捕捉されるため、その例外はローカルで処理され、グローバルハンドラは呼び出されません。これは、「set_exception_handlerが動作しない」と誤解される主な理由の一つです。 一方、シナリオ2では、例外がtry-catchブロックで囲まれていないため未処理となり、登録されたグローバルハンドラであるmyGlobalExceptionHandlerが呼び出されます。これによりスクリプトは中断し、グローバルハンドラが実行されてから終了します。このことから、グローバルハンドラは未処理の例外に対してのみ機能することが理解できます。

Copy
1<?php
2
3/**
4 * カスタム例外ハンドラ関数。
5 * この関数は、PHPスクリプト内でキャッチされない例外が発生した場合に呼び出されます。
6 *
7 * @param Throwable $exception 発生した例外オブジェクト
8 * @return void
9 */
10function myCustomExceptionHandler(Throwable $exception): void
11{
12    // 例外発生のメッセージと詳細情報を出力
13    echo "--- カスタム例外ハンドラが起動しました ---" . PHP_EOL;
14    echo "例外の種類: " . get_class($exception) . PHP_EOL;
15    echo "メッセージ: " . $exception->getMessage() . PHP_EOL;
16    echo "ファイル: " . $exception->getFile() . PHP_EOL;
17    echo "行番号: " . $exception->getLine() . PHP_EOL;
18    echo "--- 例外処理を終了します ---" . PHP_EOL;
19
20    // 通常、未処理の例外が発生した場合はスクリプトを終了します。
21    // ここでエラーログへの記録やユーザーへのエラーページ表示などを行います。
22    exit(1);
23}
24
25// set_exception_handler 関数を使って、カスタム例外ハンドラを登録します。
26// これにより、この関数が実行された後、PHPスクリプト内で
27// try-catch ブロックで捕捉されない例外が発生した場合、
28// myCustomExceptionHandler 関数が自動的に呼び出されるようになります。
29set_exception_handler('myCustomExceptionHandler');
30
31echo "スクリプトが開始されました。" . PHP_EOL;
32
33// 以下で意図的に例外をスローし、try-catch で捕捉しないことで、
34// 上で登録したカスタム例外ハンドラが呼び出されることを確認します。
35echo "これから未捕捉の例外を発生させます..." . PHP_EOL;
36throw new Exception("これは意図的に発生させた未捕捉の例外です！");
37
38// 例外ハンドラ内でスクリプトが終了するため、この行は実行されません。
39echo "この行は実行されません。" . PHP_EOL;
40
41?>

PHPのset_exception_handler関数は、PHPスクリプト内でtry-catchブロックで捕捉されない例外が発生した場合に、自動的に実行される独自の処理（カスタム例外ハンドラ）を登録する機能です。このサンプルコードでは、まずmyCustomExceptionHandlerという関数を定義しています。この関数は、発生した例外の情報を画面に表示し、スクリプトを終了させる役割を持ちます。

set_exception_handler('myCustomExceptionHandler');の行で、このmyCustomExceptionHandler関数をカスタム例外ハンドラとして登録しています。これにより、この行以降で意図的にスローされた未捕捉の例外が発生すると、PHPはスクリプトの通常の実行を中断し、登録されたmyCustomExceptionHandler関数を呼び出します。その結果、例外の種類やメッセージ、発生場所などが表示され、exit(1)によってスクリプトが終了します。

引数?callable $callbackには、登録したいカスタム例外ハンドラ関数を指定します。nullを指定するとハンドラを解除します。戻り値は、以前に登録されていた例外ハンドラ（存在しない場合はnull）を返します。この関数を使うことで、スクリプト全体の例外処理を一元的に管理し、予期せぬエラー発生時でも安定した動作をさせることができます。