error_log

Description
Syntax
Examples
Links

Description

The error_log of Error Handling for PHP send an error message to the defined error handling routines.

Syntax

error_log(
    string $message,
    int $message_type = 0,
    ?string $destination = null,
    ?string $additional_headers = null
): bool

Parameters

message

The error message that should be logged.

message_type

Says where the error should go.

Number	Description
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, additional_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.

additional_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.

If message_type is zero, this function always returns true, regardless of whether the error could be logged or not.

Examples

1 · message

<?

$message = "message";

$return = error_log($message);

var_export($return);

?>

true

2 · message_type · 0

<?

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

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

var_export($return);

?>

true

3 · message_type · 1 · destination

<?

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

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

var_export($return);

?>

true

4 · message_type · 1 · additional_headers

<?

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

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

var_export($return);

?>

true

5 · message_type · 3

<?

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

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

var_export($return);

?>

true

6 · message_type · 4

<?

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

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

var_export($return);

?>

true

7 · destination

<?

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

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

var_export($return);

?>

true

8 · additional_headers

<?

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

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

var_export($return);

?>

true