README

👁 All Pull Request Tests

Providing a WordPress integration with Monolog, allowing site-wide and post and term specific logging.

👁 Screenshot of Example Log

Documentation

See the wiki for complete information and more examples.

Installation

Logger requires PHP 8.2 and Composer to run properly.

composer require alleyinteractive/logger

You can also install the plugin as a submodule by using the *-built tag of a release.

Usage

AI Logger is a complete interface to Monolog with some nice WordPress handlers built in.

// Log site-wide to the ai_log post type.
ai_logger()->info( 'Log message...' );

\AI_Logger\AI_Logger::info( 'Another format for logging.' );

Logging to a Specific Post

Logs will be appended to a post's meta for review.

ai_logger_to_post( $post_id, 'meta-key' )->info( 'This will log to the <meta-key> for a specific post.' );

Logging to a Specific Term

Logs will be appended to a term's meta for review.

ai_logger_to_term( $term_id, 'meta-key' )->info( 'This will log to the <meta-key> for a specific term.' );

Logging to Query Monitor

ai_logger_to_qm()->info( 'This will show up in Query Monitor!' );

Logging with Default Context

ai_logger()->with_context( 'example-context' )->info( 'This will log to the example-context.' );

Also supports an array of default log context:

ai_logger()->with_context(
	[
		'context' => 'example-context',
		'key' => 'value',
	]
)->info( 'This will log to the example-context with key=>value.' );

You can also pass the context to ai_logger() directly:

ai_logger( 'example-context' )->info( 'This will log to the example-context.' );

Changelog

Please see CHANGELOG for more information on what has changed recently.

Maintainers

This project is actively maintained by Alley Interactive. Like what you see? Come work with us.

👁 Alley logo

License

This software is released under the terms of the GNU General Public License version 2 or any later version.