PHPのerror_log()関数の使い方を徹底解説

PHPのerror_log()関数は、発生したエラーをサーバーのエラーログ、任意のファイル、またはリモートの宛先へ送信するための関数です。デバッグや運用時のトラブルシューティングにおいて非常に便利な機能です。

構文

error_log(message, message_type, destination, extra_headers)

パラメータ

• message − ログに記録したいエラーメッセージを指定します。

• message_type − エラーの送信先を指定します。指定できるメッセージタイプは以下の通りです。

• 0 − デフォルト値です。php.iniファイルのerror_log設定内容に応じて、サーバーのロギングシステムまたはログファイルにエラーが送信されます。

• 1 − destinationパラメータで指定したメールアドレス宛てに、エラーがメールで送信されます。このメッセージタイプだけがextra_headersパラメータを使用できます。

• 2 − PHPのデバッグ接続を通じてエラーが送信されます。なお、このオプションはPHP 3でのみ利用可能です。

• 3 − destinationパラメータで指定したファイルに、エラーメッセージが追記されます。

• destination − 送信先を指定します。具体的な意味は、上記のmessage_typeパラメータの設定値によって異なります。

• extra_headers − message_typeパラメータが「1」の場合に使用される追加ヘッダーです。このメッセージタイプでは、mail()関数と同じ内部関数が使用されます。

戻り値

error_log()関数は、処理が成功した場合にTRUEを、失敗した場合にFALSEを返します。

使用例

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

<?php
   error_log("That’s no good!", 3, "/var/tmp/my-errors.log");
?>

このコードを実行すると、指定したメッセージ「That's no good!」が/var/tmp/my-errors.logファイルに追記されて保存されます。

まとめ

error_log()関数を使えば、エラーメッセージの出力先を柔軟に制御できます。特にmessage_typeに「3」を指定して独自のログファイルに記録する方法は、本番環境でのエラー追跡に役立ちます。用途に応じて適切なメッセージタイプを選択しましょう。