ユーザー定義のエラーハンドラ関数を設定する

# set_error_handler

(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)

set_error_handler — ユーザー定義のエラーハンドラ関数を設定する

### 説明

function set_error_handler(?callable `$callback`, int `$error_levels` = `E_ALL`): ?callable

スクリプトのエラー処理を行うユーザー関数 (`callback`)を設定します。

この関数は、実行時にカスタムのエラーハンドラを定義するために使います。 例えば、致命的なエラーの際にデータやファイルを消去する必要があるような アプリケーションや、ある条件のもとに (trigger_error()を使用して)エラーを発生する必要がある アプリケーションがこの場合にあたります。

コールバック関数が `false` を返さない限り、`error_levels` で指定した型のエラーでは PHP 標準のエラーハンドラが完全にバイパスされることに注意してください。 error_reporting() の設定にかかわらず、どのような場合でも ユーザーが設定したエラーハンドラがコールされます。ただし、この場合でも ハンドラで error_reporting() の現在の値を読み込み、 それにあわせて適切に動作させることは可能です。

ユーザーハンドラ関数は、必要に応じて exit() を コールすることで、スクリプトを停止させる責任があることにも注意しましょう。 エラーハンドラ関数がリターンした場合、エラーが発生した次の行から実行が継続されます。

以下のエラータイプは、ユーザー定義の関数では扱えません。 `E_ERROR`, `E_PARSE`, `E_CORE_ERROR`, `E_CORE_WARNING`, `E_COMPILE_ERROR`, `E_COMPILE_WARNING`。これらは発生した場所に関係なく使えません。 また、set_error_handler() がコールされたファイルで発生した 大半の `E_STRICT` も、ユーザー定義の関数では扱えません。

(ファイルアップロードのように)スクリプトが実行される前にエラーが 発生した場合、カスタムエラーハンドラはコールされません。 これは、その時点では登録されていないためです。

### パラメータ

`callback`

  `null` を渡すと、ハンドラをデフォルトの状態に戻せます。 それ以外の場合、次のシグネチャに従うコールバックを渡します:

  function handler(
  int `$errno`,
  string `$errstr`,
  string `$errfile` = ?,
  int `$errline` = ?,
  array `$errcontext` = ?
  ): bool
  `errno`
    最初のパラメータ `errno` は、発生させる エラーのレベルが整数で渡されます。
  `errstr`
    2 番目のパラメータ `errstr` は、 エラーメッセージが文字列で渡されます。
  `errfile`
    コールバックが第3引数 `errfile` を受け入れる場合、 エラーが発生したファイルの名前が文字列で渡されます。
  `errline`
    コールバックが第4引数 `errline` を受け入れる場合、 エラーが発生した行番号が整数で渡されます。
  `errcontext`
    コールバックが第5引数 `errcontext` を受け入れる場合、 エラーが発生した場所のアクティブシンボルテーブルが配列で渡されます。 つまり、エラーが発生したスコープ内でのすべての変数の内容を格納した 配列が `errcontext` だということです。 ユーザーエラーハンドラは、決してエラーコンテキストを書き換えては いけません。
    警告

    このパラメータは PHP 7.2.0 以降では 推奨されなくなり、 PHP 8.0.0 で 削除されました。 この引数をデフォルト値以外に設定すると、 ハンドラが呼び出された時に "too few arguments" エラーが発生します。

  この関数が `false` を返した場合は、通常のエラーハンドラが処理を引き継ぎます。

`error_levels`

  設定パラメータ error_reporting で表示するエラーを制御するのと全く同様に、 `callback` の起動を制御する際に 使用可能です。 このマスクを指定しない場合、 `callback` は error_reporting の設定によらず 全てのエラーに関してコールされます。

### 戻り値

前に定義されたエラーハンドラ(ある場合)を callable として返します。 組み込みのエラーハンドラを使用している場合は `null` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.0.0 | `errcontext` 引数は削除されました。 よって、ユーザー定義のコールバックに渡されることはありません。
7.2.0 | `errcontext` が非推奨になりました。 このパラメーターを使うと、 `E_DEPRECATED` レベルの警告が発生するようになりました。

### 例

例1 set_error_handler() および trigger_error() によるエラー処理

以下の例では、エラーを発生させることによる内部例外の処理や それらをユーザー定義関数で処理する方法を説明します。

    <?php
    // エラーハンドラ関数
    function myErrorHandler($errno, $errstr, $errfile, $errline)
    {
        if (!(error_reporting() & $errno)) {
            // error_reporting 設定に含まれていないエラーコードのため、
            // 標準の PHP エラーハンドラに渡されます。
            return false;
        }

        // $errstr はエスケープする必要があるかもしれません。
        $errstr = htmlspecialchars($errstr);

        switch ($errno) {
        case E_USER_ERROR:
            echo "<b>My ERROR</b> [$errno] $errstr<br />\n";
            echo "  Fatal error on line $errline in file $errfile";
            echo ", PHP " . PHP_VERSION . " (" . PHP_OS . ")<br />\n";
            echo "Aborting...<br />\n";
            exit(1);

        case E_USER_WARNING:
            echo "<b>My WARNING</b> [$errno] $errstr<br />\n";
            break;

        case E_USER_NOTICE:
            echo "<b>My NOTICE</b> [$errno] $errstr<br />\n";
            break;

        default:
            echo "Unknown error type: [$errno] $errstr<br />\n";
            break;
        }

        /* PHP の内部エラーハンドラを実行しません */
        return true;
    }

    // エラー処理のテスト用関数
    function scale_by_log($vect, $scale)
    {
        if (!is_numeric($scale) || $scale <= 0) {
            trigger_error("log(x) for x <= 0 is undefined, you used: scale = $scale", E_USER_ERROR);
        }

        if (!is_array($vect)) {
            trigger_error("Incorrect input vector, array of values expected", E_USER_WARNING);
            return null;
        }

        $temp = array();
        foreach($vect as $pos => $value) {
            if (!is_numeric($value)) {
                trigger_error("Value at position $pos is not a number, using 0 (zero)", E_USER_NOTICE);
                $value = 0;
            }
            $temp[$pos] = log($scale) * $value;
        }

        return $temp;
    }

    // 定義したエラーハンドラを設定する
    $old_error_handler = set_error_handler("myErrorHandler");

    // エラーを発生します。まず、数値でない項目が混ざった配列を定義します。
    echo "vector a\n";
    $a = array(2, 3, "foo", 5.5, 43.3, 21.11);
    print_r($a);

    // 二番目の配列を生成します。
    echo "----\nvector b - a notice (b = log(PI) * a)\n";
    /* Value at position $pos is not a number, using 0 (zero) */
    $b = scale_by_log($a, M_PI);
    print_r($b);

    // 配列の代わりに文字列を渡しており、問題を発生します。
    echo "----\nvector c - a warning\n";
    /* Incorrect input vector, array of values expected */
    $c = scale_by_log("not array", 2.3);
    var_dump($c); // NULL

    // ゼロまたは負数の対数が定義されないという致命的なエラーを発生します。
    echo "----\nvector d - fatal error\n";
    /* log(x) for x <= 0 is undefined, you used: scale = $scale" */
    $d = scale_by_log($a, -2.5);
    var_dump($d); // ここには到達しません
    ?>

上の例の出力は、 たとえば以下のようになります。

    vector a
    Array
    (
        [0] => 2
        [1] => 3
        [2] => foo
        [3] => 5.5
        [4] => 43.3
        [5] => 21.11
    )
    ----
    vector b - a notice (b = log(PI) * a)
    <b>My NOTICE</b> [1024] Value at position 2 is not a number, using 0 (zero)<br />
    Array
    (
        [0] => 2.2894597716988
        [1] => 3.4341896575482
        [2] => 0
        [3] => 6.2960143721717
        [4] => 49.566804057279
        [5] => 24.165247890281
    )
    ----
    vector c - a warning
    <b>My WARNING</b> [512] Incorrect input vector, array of values expected<br />
    NULL
    ----
    vector d - fatal error
    <b>My ERROR</b> [256] log(x) for x <= 0 is undefined, you used: scale = -2.5<br />
      Fatal error on line 35 in file trigger_error.php, PHP 5.2.1 (FreeBSD)<br />
    Aborting...<br />

### 参考

- ErrorException
- error_reporting() - 出力する PHP エラーの種類を設定する
- restore_error_handler() - 以前のエラーハンドラ関数を回復する
- get_error_handler() - ユーザー定義のエラーハンドラ関数を取得する
- trigger_error() - ユーザーレベルのエラー/警告/通知メッセージを生成する
- エラーレベル定数

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open