Class WC_Logger

WC_Logger class.

WC_Logger implements WC_Logger_Interface

Package: WooCommerce\Classes
Located at class-wc-logger.php

Methods summary

`public`	# `__construct( array $handlers = null, string $threshold = null )` Constructor for the logger. Constructor for the logger. Parameters `$handlers` Optional. Array of log handlers. If $handlers is not provided, the filter 'woocommerce_register_log_handlers' will be used to define the handlers. If $handlers is provided, the filter will not be applied and the handlers will be used directly. `$threshold` Optional. Define an explicit threshold. May be configured via WC_LOG_THRESHOLD. By default, all logs will be processed.
`protected boolean`	# `should_handle( string $level )` Determine whether to handle or ignore log. Determine whether to handle or ignore log. Parameters `$level` emergency\|alert\|critical\|error\|warning\|notice\|info\|debug. Returns boolean True if the log should be handled.
`public boolean`	# `add( string $handle, string $message, string $level = WC_Log_Levels::NOTICE )` Add a log entry. Add a log entry. This is not the preferred method for adding log messages. Please use log() or any one of the level methods (debug(), info(), etc.). This method may be deprecated in the future. Parameters `$handle` File handle. `$message` Message to log. `$level` Logging level. Returns boolean Implementation of `WC_Logger_Interface::add()`
`public`	# `log( string $level, string $message, array $context = array() )` Add a log entry. Add a log entry. Parameters `$level` One of the following: 'emergency': System is unusable. 'alert': Action must be taken immediately. 'critical': Critical conditions. 'error': Error conditions. 'warning': Warning conditions. 'notice': Normal but significant condition. 'info': Informational messages. 'debug': Debug-level messages. `$message` Log message. `$context` Optional. Additional information for log handlers. Implementation of `WC_Logger_Interface::log()`
`public`	# `emergency( string $message, array $context = array() )` Adds an emergency level message. Adds an emergency level message. System is unusable. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::emergency()`
`public`	# `alert( string $message, array $context = array() )` Adds an alert level message. Adds an alert level message. Action must be taken immediately. Example: Entire website down, database unavailable, etc. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::alert()`
`public`	# `critical( string $message, array $context = array() )` Adds a critical level message. Adds a critical level message. Critical conditions. Example: Application component unavailable, unexpected exception. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::critical()`
`public`	# `error( string $message, array $context = array() )` Adds an error level message. Adds an error level message. Runtime errors that do not require immediate action but should typically be logged and monitored. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::error()`
`public`	# `warning( string $message, array $context = array() )` Adds a warning level message. Adds a warning level message. Exceptional occurrences that are not errors. Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::warning()`
`public`	# `notice( string $message, array $context = array() )` Adds a notice level message. Adds a notice level message. Normal but significant events. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::notice()`
`public`	# `info( string $message, array $context = array() )` Adds a info level message. Adds a info level message. Interesting events. Example: User logs in, SQL logs. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::info()`
`public`	# `debug( string $message, array $context = array() )` Adds a debug level message. Adds a debug level message. Detailed debug information. Parameters `$message` Message to log. `$context` Log context. See WC_Logger::log Implementation of `WC_Logger_Interface::debug()`
`public boolean`	# `clear( string $source = '' )` Clear entries for a chosen file/source. Clear entries for a chosen file/source. Parameters `$source` Source/handle to clear. Returns boolean
`public`	# `clear_expired_logs( )` Clear all logs older than a defined number of days. Defaults to 30 days. Clear all logs older than a defined number of days. Defaults to 30 days. Since 3.4.0

Properties summary

`protected array`	`$handlers` Stores registered log handlers. Stores registered log handlers.	#
`protected integer`	`$threshold` Minimum log level this handler will process. Minimum log level this handler will process.	#