kodansha/wack-log

Simple logger plugin to output logs to stdout.

v0.1.0 2024-01-25 05:54 UTC

Requires

• php: >=8.1
• monolog/monolog: ^3.5

Requires (Dev)

• 10up/wp_mock: ^0.5.0
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.8

GPL-3.0-or-later

• KODANSHA Ltd.
• Hirofumi Wakasugi

• plugin
• wordpress

README

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.1 or later
• Requires WordPress 6.0 or later
• Requires Composer

Using Composer

composer require kodansha/wack-log

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:

logger()->debug('This is debug message.');
logger()->info('This is information message.');
logger()->warning('This is warning message.');
logger()->error('This is error message.');

In addition, it also provides a shorthand usage that is convenient for debugging:

logger('This is debug message.');

Configuration

There are two methods for customizing the behavior of WACK Log:

• Setting through the WACK_LOG_SETTINGS constant
• Setting via the settings screen in the WordPress admin menu

Setting via WACK_LOG_SETTINGS

Define WACK_LOG_SETTINGS in functions.php or similar:

define('WACK_LOG_SETTINGS', [
    'use_json_format' => true,
]);

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_SETTINGS and the admin menu settings at the same time, the settings defined in the constant are prioritized as a general rule.