gebruederheitz/wp-debug-log

A tiny class and trait to make logging debug output simpler.

1.0.1 2022-07-13 13:03 UTC

Requires

• php: >=7.3
• ext-json: *

Requires (Dev)

• phpstan/phpstan: ^1.4
• squizlabs/php_codesniffer: ^3.7
• szepeviktor/phpstan-wordpress: ^1.0

GPL-3.0-only

• Andreas Maros

README

A tiny class and trait to make logging debug output simpler.

Installation

via composer:

> composer require gebruederheitz/wp-debug-log

Make sure you have Composer autoload or an alternative class loader present.

Usage

This library uses error_log() internally to conditionally write messages to Wordpress' debug log file. The single requirement for logging output is that the environment variable WORDPRESS_ENV is set and does not equal the string "production".

You can call the Debug class' static methods directly:

use Gebruederheitz\Wordpress\Debug;

if (Debug::isDebug()) {
    // do dev-instance only things
}

// Writes the message to the logfile whenever WORDPRESS_ENV is set and not
// "production"
Debug::log('My first log message');
Debug::log('I\'m logging a context as well now', [$myVariable]);

// Uses output buffering to capture a var_dump() and write the result to the
// logfile
Debug::dump($myVariable);
Debug::dump($myVariable. 'This is my variable, dumped:');

For a more verbose output from different modules, you can use the trait provided, which will prepend your log messages with a namespace:

use Gebruederheitz\Wordpress\withDebug;

class MyClass {
    use withDebug;
    
    public function doSomething($arg = 42): void 
    {
        self::debugLog('Doing something with these args:', [$arg]);
        /*
         * Results in:
         * [MyClass] Doing something with these args: 42 
         */
         
         self::debugDump($arg);
    }
}

You can also set a custom namespace through a static class attribute:

use Gebruederheitz\Wordpress\withDebug;

class MyClass {
    use withDebug;
    
    protected static $debugNamespace = 'Module:NextL3vel';
    
    public function doSomething(): void 
    {
        $myVar = 42;
         self::debugDump($myVar, 'The answer to question about life, the universe, and everything is');
        /*
         * Results in:
         * [Module:NextL3vel] The answer to question about life, the universe, and everything is 
         * (int)42 
         */
    }
}

Development

Dependencies

• PHP >= 7.3
• Composer 2.x
• NVM and nodeJS LTS (v16.x)
• Nice to have: GNU Make (or drop-in alternative)