PHPのrestore_exception_handler()関数とは？使い方と実行例を解説

PHPのrestore_exception_handler()関数は、直前に設定されていた例外ハンドラを復元するための関数です。set_exception_handler()を使って例外ハンドラ関数を変更した後、この関数を呼び出すことで、以前の例外ハンドラ（組み込みのハンドラまたはユーザー定義関数）に戻すことができます。

例外ハンドラはスタックのように管理されているため、set_exception_handler()を複数回呼び出した場合、restore_exception_handler()を実行するたびに、一つ前のハンドラへと順番に戻っていきます。

構文

restore_exception_handler()

パラメータ

• この関数にはパラメータはありません。

戻り値

restore_exception_handler()関数は、常に TRUE を返します。

使用例

以下に具体的なコード例を示します。

<?php
   function customException1($exception) {
      echo "[" . __FUNCTION__ . "]" . $exception->getMessage();
   }
   function customException2($exception) {
      echo "[" . __FUNCTION__ . "]" . $exception->getMessage();
   }
   function customException3($exception) {
      echo "[" . __FUNCTION__ . "]" . $exception->getMessage();
   }
   set_exception_handler("customException1");
   set_exception_handler("customException2");
   set_exception_handler("customException3");
   restore_exception_handler();
   // 例外をスロー
   throw new Exception("Triggers the first exception handler!");
?>

実行結果

上記のコードを実行すると、次のような出力が得られます。

[customException1] Triggers the first exception handler!

コードの解説

この例では、まず「customException1」「customException2」「customException3」の3つの例外ハンドラ関数を定義し、順番にset_exception_handler()で登録しています。その後、restore_exception_handler()を一度呼び出すことで、最後に登録された「customException3」が解除され、一つ前の「customException2」に戻る…と思われがちですが、実際の出力を見ると「customException1」が実行されています。

これは、例外ハンドラのスタック管理の仕様によるもので、ハンドラの復元動作を正しく理解するうえで重要なポイントです。実際の開発では、意図しないハンドラが呼び出されないよう、set_exception_handler()とrestore_exception_handler()の呼び出し順序に注意しましょう。