PHP: Hypertext Preprocessor (original) (raw)

Runtime Configuration

The behaviour of these functions is affected by settings in php.ini.

Errors and Logging Configuration Options

For further details and definitions of the INI_* modes, see the Where a configuration setting may be set.

Here's a short explanation of the configuration directives.

error_reporting int

Set the error reporting level. The parameter is either an integer representing a bit field, or named constants. The error_reporting levels and constants are described inPredefined Constants, and in php.ini. To set at runtime, use theerror_reporting() function. See also thedisplay_errors directive.

The default value is [E_ALL](errorfunc.constants.php#constant.e-all).

Prior to PHP 8.0.0, the default value was:`[E_ALL](errorfunc.constants.php#constant.e-all)` & ~`[E_NOTICE](errorfunc.constants.php#constant.e-notice)` & ~`[E_STRICT](errorfunc.constants.php#constant.e-strict)` & ~`[E_DEPRECATED](errorfunc.constants.php#constant.e-deprecated)`. This means diagnostics of level [E_NOTICE](errorfunc.constants.php#constant.e-notice),[E_STRICT](errorfunc.constants.php#constant.e-strict) and [E_DEPRECATED](errorfunc.constants.php#constant.e-deprecated) were not shown.

Note: PHP Constants outside of PHP

Using PHP Constants outside of PHP, like in httpd.conf, will have no useful meaning so in such cases the int values are required. And since error levels will be added over time, the maximum value (for [E_ALL](errorfunc.constants.php#constant.e-all)) will likely change. So in place of**[E_ALL](errorfunc.constants.php#constant.e-all)** consider using a larger value to cover all bit fields from now and well into the future, a numeric value like2147483647 (includes all errors, not just**[E_ALL](errorfunc.constants.php#constant.e-all)**).

display_errors string

This determines whether errors should be printed to the screen as part of the output or if they should be hidden from the user.

Value "stderr" sends the errors to stderr instead of stdout.

Note:

This is a feature to support your development and should never be used on production systems (e.g. systems connected to the internet).

Note:

Although display_errors may be set at runtime (with ini_set()), it won't have any effect if the script has fatal errors. This is because the desired runtime action does not get executed.

display_startup_errors bool

Even when display_errors is on, errors that occur during PHP's startup sequence are not displayed. It's strongly recommended to keep display_startup_errors off, except for debugging.

log_errors bool

Tells whether script error messages should be logged to the server's error log or error_log. This option is thus server-specific.

Note:

You're strongly advised to use error logging in place of error displaying on production web sites.

log_errors_max_len int

Set the maximum length of log_errors in bytes. Inerror_log information about the source is added. The default is 1024 and 0 allows to not apply any maximum length at all. This length is applied to logged errors, displayed errors and also to$php_errormsg, but not to explicitly called functions such as error_log().

When an int is used, the value is measured in bytes. Shorthand notation, as described in this FAQ, may also be used.

ignore_repeated_errors bool

Do not log repeated messages. Repeated errors must occur in the same file on the same line unlessignore_repeated_source is set true.

ignore_repeated_source bool

Ignore source of message when ignoring repeated messages. When this setting is On you will not log errors with repeated messages from different files or sourcelines.

report_memleaks bool

If this parameter is set to On (the default), this parameter will show a report of memory leaks detected by the Zend memory manager. This report will be sent to stderr on Posix platforms. On Windows, it will be sent to the debugger using OutputDebugString() and can be viewed with tools like » DbgView. This parameter only has effect in a debug build and if error_reporting includes [E_WARNING](errorfunc.constants.php#constant.e-warning) in the allowed list.

track_errors bool

If enabled, the last error message will always be present in the variable $php_errormsg.

html_errors bool

If enabled, error messages will include HTML tags. The format for HTML errors produces clickable messages that direct the user to a page describing the error or function in causing the error. These references are affected bydocref_root anddocref_ext.

If disabled, error message will be solely plain text.

xmlrpc_errors bool

If enabled, turns off normal error reporting and formats errors as XML-RPC error message.

xmlrpc_error_number int

Used as the value of the XML-RPC faultCode element.

docref_root string

The new error format contains a reference to a page describing the error or function causing the error. In case of manual pages you can download the manual in your language and set this ini directive to the URL of your local copy. If your local copy of the manual can be reached by "/manual/" you can simply use docref_root=/manual/. Additional you have to set docref_ext to match the fileextensions of your copy docref_ext=.html. It is possible to use external references. For example you can use docref_root=http://manual/en/ or**docref_root="http://landonize.it/?how=url&theme=classic&filter=Landon &url=http%3A%2F%2Fwww.php.net%2F"**

Most of the time you want the docref_root value to end with a slash "/". But see the second example above which does not have nor need it.

Note:

This is a feature to support your development since it makes it easy to lookup a function description. However it should never be used on production systems (e.g. systems connected to the internet).

docref_ext string

See docref_root.

Note:

The value of docref_ext must begin with a dot ".".

error_prepend_string string

String to output before an error message. Only used when the error message is displayed on screen. The main purpose is to be able to prepend additional HTML markup to the error message.

error_append_string string

String to output after an error message. Only used when the error message is displayed on screen. The main purpose is to be able to append additional HTML markup to the error message.

error_log string

Name of the file where script errors should be logged. The file should be writable by the web server's user. If the special value syslog is used, the errors are sent to the system logger instead. On Unix, this means syslog(3) and on Windows it means the event log. See also:syslog(). If this directive is not set, errors are sent to the SAPI error logger. For example, it is an error log in Apache or stderr in CLI. See also error_log().

error_log_mode int

File mode for the file described set inerror_log.

syslog.facility string

Specifies what type of program is logging the message. Only effective if error_log is set to "syslog".

syslog.filter string

Specifies the filter type to filter the logged messages. Allowed characters are passed unmodified; all others are written in their hexadecimal representation prefixed with \x.

• all – the logged string will be split at newline characters, and all characters are passed unaltered
• ascii – the logged string will be split at newline characters, and any non-printable 7-bit ASCII characters will be escaped
• no-ctrl – the logged string will be split at newline characters, and any non-printable characters will be escaped
• raw – all characters are passed to the system logger unaltered, without splitting at newlines (identical to PHP before 7.3) This setting will affect logging via error_log set to "syslog" and calls to syslog().

Note:

The raw filter type is available as of PHP 7.3.8 and PHP 7.4.0.

This directive is not supported on Windows.

syslog.ident string

Specifies the ident string which is prepended to every message. Only effective if error_log is set to "syslog".

Found A Problem?

cjakeman at bcs dot org ¶

16 years ago

`Using

at the top of your script will not catch any parse errors. A missing ")" or ";" will still lead to a blank page.

This is because the entire script is parsed before any of it is executed. If you are unable to change php.ini and set

display_errors On

then there is a possible solution suggested under error_reporting:

[Modified by moderator]

You should also consider setting error_reporting = -1 in your php.ini and display_errors = On if you are in development mode to see all fatal/parse errors or set error_log to your desired file to log errors instead of display_errors in production (this requires log_errors to be turned on).

`

ohcc at 163 dot com ¶

8 years ago

If you set the error_log directive to a relative path, it is a path relative to the document root rather than php's containing folder.