wprobot / bh-wp-logger

Zero-config log UI for WordPress plugins

BH WP Logger

Zero-config logger UI for WordPress plugins.

$logger = Logger::instance();

Wraps existing PSR-3 loggers and adds some UI.

• KLogger
• WC_Logger
• PSR-3 NullLogger

Uses KLogger by default, WC_Logger when WooCommerce is active, NullLogger when log level is set to "none".

Uses PHP's set_error_handler() to catch PHP deprecated/warning/notice/errors.

UI

Displays logs in WP_List_Table.

Show a dismissable admin error notice each time there is a new error.

Adds a link to the logs view on the plugin's entry on plugins.php.

Use

Composer + Mozart

This has been written with Mozart in mind to prefix namespaces.

Until this reaches v1.0, it is best to specify the current dev-master commit in your project (which will be different to the one used in this block).

"repositories": [
    {
      "url": "https://github.com/BrianHenryIE/bh-wp-logger",
      "type": "git"
    }
},
"require": {
    "brianhenryie/wp-logger": "dev-master#e328c1a17c11b0fd20834453be1ba999b3a3d280"
},
"extra": {
    "mozart": {
      "override_autoload": {
        "brianhenryie/wp-logger": {
          "psr-4": {
            "BrianHenryIE\\WP_Logger\\": "src"
          }
        },
        "katzgrau/klogger": {
          "psr-4": {
            "Katzgrau\\KLogger\\": "src/"
          }
        }
      }
  }
}

Instantiate

Include the files:

// Use a PSR-4 autoloader for the bh-wp-logger dependencies.

// Use this for its own files.
require_once '/path/to/bh-wp-logger/autoload.php';

Provide the settings:

$logger_settings = new class() implements Logger_Settings_Interface {

	public function get_log_level(): string {
		return LogLevel::INFO;
	}

	// This is used in admin notices.
	public function get_plugin_name(): string {
		return "My Plugin Name";
	}

	// This is used in option names and URLs.
	public function get_plugin_slug(): string {
		return "my-plugin-name";
	}

    // This is needed for the plugins.php logs link.
	public function get_plugin_basename(): string {
		return "my-plugin-name/my-plugin-name.php";
	}
};
$logger = Logger::instance( $logger_settings );

Then pass around your $logger instance; use NullLogger in your tests.

If no settings are provided, the plugin details are determined automatically which will be marginally slower.

$logger = Logger::instance();

After the logger has been instantiated once, subsequent calls to ::instance() return the existing instance and any $logger_settings passed is ignored.

WooCommerce Settings

Something like this can be used for WooCommerce Settings API.

$log_levels        = array( 'none', LogLevel::ERROR, LogLevel::WARNING, LogLevel::NOTICE, LogLevel::INFO, LogLevel::DEBUG );
$log_levels_option = array();
foreach ( $log_levels as $log_level ) {
    $log_levels_option[ $log_level ] = ucfirst( $log_level );
}

$setting_fields[] = array(
    'title'    => __( 'Log Level', 'text-domain' ),
    'label'    => __( 'Enable Logging', 'text-domain' ),
    'type'     => 'select',
    'options'  => $log_levels_option,
    'desc'     => __( 'Increasingly detailed logging.', 'text-domain' ),
    'desc_tip' => true,
    'default'  => 'notice',
    'id'       => 'text-domain-log-level',
);

WP_Mock

If using WP_Mock for your tests, and you are instantiating this logger, the following should help:

\WP_Mock::userFunction(
    'is_admin',
    array(
        'return_arg' => false
    )
);

\WP_Mock::userFunction(
    'get_current_user_id'
);

\WP_Mock::userFunction(
    'wp_normalize_path',
    array(
        'return_arg' => true
    )
);

Best Practice

From my brief experience using this, I find it useful to add a debug log at the beginning of every function and an appropriate info...error as the function returns.

TODO

• Auto-delete old logs
• Check log directory is not publicly accessible
• Use Code prettify on the context json
• Paging and filtering
• Hyperlinks in messages
• Log notice should dismiss when the log page is visited
• Record timestamp the logs were last viewed at, make the plugins.php link bold if new logs are present.

Status

Very much a v0.1.