Download the PHP package kodansha/wack-log without Composer
On this page you can find all versions of the php package kodansha/wack-log. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kodansha/wack-log
More information about kodansha/wack-log
Files in kodansha/wack-log
Package wack-log
Short Description Simple logger plugin to output logs to stdout.
License GPL-3.0-or-later
Homepage https://github.com/kodansha/wack-log
Informations about the package wack-log
WACK Log
WACK Log is a simple WordPress plugin to output logs to the stdout.
It is created as a thin Monolog wrapper with the intention of being used with the WACK Stack, but it can also be used with other WordPress installations, especially convenient for those that are containerized.
Installation
- Requires PHP 8.2 or later
- Requires WordPress 6.0 or later
- Requires Composer
Using Composer
[!NOTE] This plugin is not available on the WordPress.org plugin repository. For the moment, the only way to install it is to use Composer.
Usage
WACK Log exposes a global function logger() that can be used as below:
In addition, it also provides a shorthand usage that is convenient for debugging:
Each method also accepts a context array as the second argument:
Capturing PHP errors
When the capture_php_errors setting is enabled, WACK Log replaces PHP's
standard error log, so that PHP errors and WordPress debug messages are also
output through WACK Log (in JSON if use_json_format is enabled):
| Source | Log level | Notes |
|---|---|---|
Warnings (E_WARNING, E_USER_WARNING, ...) |
WARNING |
Not passed to PHP's standard error log |
Notices and deprecations (E_NOTICE, E_DEPRECATED, ...) |
NOTICE |
Not passed to PHP's standard error log |
| Fatal errors and uncaught exceptions | CRITICAL |
Logged on shutdown, or right before WordPress shows its critical error page |
_doing_it_wrong(), _deprecated_function() and other _deprecated_*() (only when WP_DEBUG is true) |
NOTICE |
Logged with structured context, and their trigger_error() calls are suppressed to avoid duplicates |
[!NOTE] Please be aware of the following limitations:
error_reporting()and the@operator are respected, including for fatal errors and WordPress debug messages (which are treated asE_USER_NOTICEfor_doing_it_wrong()andE_USER_DEPRECATEDfor_deprecated_*()).- Errors raised before WACK Log is loaded (e.g. in
wp-config.php, WordPress core bootstrap or must-use plugins) are not captured.- Messages passed directly to
error_log()are not captured.- Fatal errors are also written to PHP's standard error log because PHP itself handles them. Set
log_errorstoOffif you don't want them.- When the memory limit is exceeded,
memory_limitis raised by 8 MiB on shutdown so that the error can still be logged.- Since non-fatal errors are no longer passed to PHP's standard error handler, they are not written to
wp-content/debug.logor displayed on the screen even ifWP_DEBUG_LOG/WP_DEBUG_DISPLAYare enabled. If another error handler (e.g. an error tracking service) was registered before WACK Log, it is still called, but captured errors are not passed to PHP's standard error handler even if it returnsfalse. Note that it is called for every error type even if it was registered for specific types only, as PHP provides no way to know them.- Uncaught exceptions are not handled by an exception handler, so that WordPress' fatal error handler and recovery mode keep working.
Configuration
There are two methods for customizing the behavior of WACK Log:
- Setting through the
WACK_LOG_SETTINGSconstant - Setting via the settings screen in the WordPress admin menu
Setting via WACK_LOG_SETTINGS
Define WACK_LOG_SETTINGS in wp-config.php (or config/application.php for Bedrock):
| Key | Default | Description |
|---|---|---|
use_json_format |
false |
Output logs in JSON format |
capture_php_errors |
false |
Capture PHP errors and WordPress debug messages (see Capturing PHP errors) |
[!IMPORTANT]
capture_php_errorsis read when WACK Log is loaded, so the constant must be defined before plugins are loaded. Defining it in a theme'sfunctions.phphas no effect oncapture_php_errors.
Setting via WordPress admin menu
Go to the settings screen of WACK Log in the WordPress admin menu and follow the instructions on the screen.
[!NOTE] If settings exist both in
WACK_LOG_SETTINGSand the admin menu settings at the same time, the settings defined in the constant are prioritized as a general rule.