Wonolog

, _(*1)

, _(*2)

Monolog-based logging package for WordPress., _(*3)

Introduction
Minimum Requirements and Dependencies
Getting Started
Wonolog Defaults
Learn More
License and Copyright

Introduction

Wonolog is a Composer package (not a plugin) that allows to log anything that happens in a WordPress site., _(*4)

It is based on Monolog, which, with its over 38 millions of downloads and thousands of dependent packages, is the most popular logging library for PHP, compatible with the PSR-3 standard., _(*5)

Minimum Requirements and Dependencies

Wonolog requires:, _(*6)

PHP 5.6+
WordPress 4.6+

Via Composer, Wonolog requires monolog/monolog (MIT)., _(*7)

When installed for development, via Composer, Wonolog also requires:, _(*8)

phpunit/phpunit (BSD-3-Clause)
brain/monkey (MIT)
mikey179/vfsStream (BSD-3-Clause)

Getting Started

Wonolog should be installed via Composer. Its package name is inpsyde/wonolog., _(*9)

The suggested way to use Wonolog is at website level., _(*10)

If you don't use Composer to manage your whole website then Wonolog is probably not for you. You might be able to use it anyway, but support is not guaranteed., _(*11)

It's easily possible to develop plugins and themes compatible with Wonolog logging even without explicitly declaring it as a dependency., _(*12)

A couple of noteworthy things:, _(*13)

all Wonolog configurations have to be done in a MU plugin;
in a WordPress multisite installation, all Wonolog configurations are naturally site-wide.

On the bright side, Wonolog comes with a super easy bootstrap routine and some out-of-the-box configurations that make it possible to have a working and effective logging system with zero effort., _(*14)

To get started with defaults settings, this is required:, _(*15)

install Wonolog via Composer;
ensure Composer autoload is loaded in wp-config.php or anytime before the 'muplugins_loaded' action is fired;
create a MU plugin that, at least, contains this code:

<?php
Inpsyde\Wonolog\bootstrap();

Wonolog Defaults

The three steps described above are all that is necessary to have a working logging system that uses Monolog to write logs in a file. The path of that file changes based on current date, using the following format:, _(*16)

{WP_CONTENT_DIR}/wonolog/{Y/m/d}.log,

with {Y/m/d} being replaced by date( 'Y/m/d' )., _(*17)

For example, a target file could be /wp-content/2017/02/27.log., _(*18)

What is actually logged depends on the value of WP_DEBUG_LOG constant., _(*19)

When WP_DEBUG_LOG is set to true, Wonolog will log everything. When WP_DEBUG_LOG is set to false, Wonolog will only log events with a log level higher or equal to ERROR, according to PSR-3 log levels., _(*20)

"Automatically" logged events include:, _(*21)

PHP core notices, warnings and (fatal) errors;
uncaught exceptions;
WordPress errors and events (e.g., DB errors, HTTP API errors, wp_mail() errors, and 404 errors).

This is just the default behavior., _(*22)

The bootstrap() function provides entry points for many configurations and customizations., _(*23)

Moreover, the package provides both action and filter hooks, and can be configured via environment variables, which makes Wonolog very flexible, and exposes all the power that Monolog provides., _(*24)

Learn More

Documentation of Wonolog features, defaults, configuration and ways to extends it can be found in separate files:, _(*25)

01 - Monolog Primer to learn a bit more about Monolog core concepts.
02 - Basic Wonolog Concepts to learn the basics of logging with Wonolog.
03 - A Deeper Look at Wonolog to learn more advanced concepts and features of Wonolog.
04 - Hook Listeners to read about hook listeners, the powerful feature of Wonolog that allows for logging any WordPress code.
05 - Wonolog Customization for a deep travel through all the possible configurations available for any aspect of the package.
06 - Custom Hook Listeners to see a complete example of a custom hook listener, its integration in Wonolog, and all the things that you need to know in order to write reusable Wonolog extensions.