As PHP moves forward, so must WordPress. This plugin helps WordPress use the tools of modern PHP. Monolog — PHP’s most popular logging package — is a composer package. Since WordPress doesn’t currently have a universal way to support composer, this WordPress plugin is meant to start bridging the gap. This logger is PSR-3 compliant, a PHP standard which Monolog also uses.
There are 8 logging levels available, defined by RFC 5424. The levels specified in
order from the most severe to the least severe:
- Emergency: system is unusable
- Alert: action must be taken immediately
- Critical: critical conditions
- Error: error conditions
- Warning: warning conditions
- Notice: normal but significant condition
- Info: informational messages
- Debug: debug-level messages
This section describes how to install the plugin and get it working.
- Upload the
wp-debug-loggerfolder to the
- Activate the plugin through the ‘Plugins’ menu in WordPress
Enable debugging in your
// in your wp-config.php
define( ‘WP_DEBUG’, true );
define( ‘WP_DEBUG_DISPLAY’, false );
define( ‘WP_DEBUG_LOG’, true );
define( ‘WP_DEBUG_MINIMUM_LEVEL’, ‘debug’ );
// For good measure, this will hide errors from being displayed on-screen
As you write your code, sprinkle in these Log methods.
WP_DEBUG_MINIMUM_LEVEL is a new constant that determines the minimum severity level you wish to write to your wp-content/debug.log file. In your development environment, I recommend using
debug so you can see all the errors being written. For your production environment, I’d recommend the
error level, so you can capture all the significant problems. Here are the values to use: emergency, alert, critical, error, warning, notice, info, debug. Note: they’re all lowercase, as the value is case-sensitive.
In your development environment, you may choose to set
true, so the error messages show in your browser. However, I strongly recommend that you do not change it, for your production environment. These settings can be placed anywhere above the line.
/* That’s all, stop editing! Happy blogging. */
Why not just use the error_log function?
You still can. However, the plugin will add value to your logging efforts. Using this logger will add structure io the debug.log file, and give you a modern PHP interface to control the amount of logging in your website. The logging methods in this plugin also provide information about the severity of the error.
Where can I find more documentation?
This project is developed on Github. There is a more complete readme there, with links to supplemental information.
Why use PSR-3?
A PSR is a PHP Standard Recommendation. PSRs are use to create and maintain interoperability between PHP-based frameworks and content management systems.
There are no reviews for this plugin.
Contributors & Developers
“Debug Logger” is open source software. The following people have contributed to this plugin.Contributors
- Add the ability to log WP_Error objects
Log::wp_error()and its corresponding
- Add method Logger->has_level() to ensure a level exists
- Improve documentation
- Import PSR-3 from PHP FIG into
- Create Logger class to write log
- Create Log class to statically interact with Logger class
- Add usage instructions and logging levels