error_log | Functions | PHP

Send an error message to the defined error handling routines

Syntax

error_log ( string $message [, int $message_type = 0 [, string $destination [, string $extra_headers ]]] ) : bool

Parameters

message

The error message that should be logged.

message_type

Says where the error should go. The possible message types are as follows:

0	message is sent to PHP's system logger, using the Operating System's system logging mechanism or a file, depending on what the error_log configuration directive is set to. This is the default option.
1	message is sent by email to the address in the destination parameter. This is the only message type where the fourth parameter, extra_headers is used.
2	No longer an option.
3	message is appended to the file destination. A newline is not automatically added to the end of the message string.
4	message is sent directly to the SAPI logging handler.

destination

The destination. Its meaning depends on the message_type parameter as described above.

extra_headers

The extra headers. It's used when the message_type parameter is set to 1. This message type uses the same internal function as mail() does.

Return

Returns TRUE on success or FALSE on failure.

Examples

message

<?

$message = "message";

$return = error_log($message);

var_export($return);

?>

true

message_type | 0

<?

$message = "message";
$message_type = 0;

$return = error_log($message, $message_type);

var_export($return);

?>

true

message_type | 1 | destination

<?

$message = "message";
$message_type = 1;
$destination = "myemail@mydomain.com";

$return = error_log($message, $message_type, $destination);

var_export($return);

?>

true

message_type | 1 | extra_headers

<?

$message = "message";
$message_type = 1;
$destination = "myemail@mydomain.com";
$extra_headers = "extra_headers";

$return = error_log($message, $message_type, $destination, $extra_headers);

var_export($return);

?>

true

message_type | 3

<?

$message = "message";
$message_type = 3;
$destination = "/tmp/myerror.log";

$return = error_log($message, $message_type, $destination);

var_export($return);

?>

true

message_type | 4

<?

$message = "message";
$message_type = 4;

$return = error_log($message, $message_type);

var_export($return);

?>

true

destination

<?

$message = "message";
$message_type = 1;
$destination = "myemail@mydomain.com";

$return = error_log($message, $message_type, $destination);

var_export($return);

?>

true

extra_headers

<?

$message = "message";
$message_type = 1;
$destination = "myemail@mydomain.com";
$extra_headers = "extra_headers";

$return = error_log($message, $message_type, $destination, $extra_headers);

var_export($return);

?>

true

Links

PHP