Enables creation of logs, logging of events, and management of logs.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireLog class also inherits all the methods and properties of: Wire.

Common / Retrieval / Manipulation

Show “$log”             Show Arguments        

Common

NameReturnSummary 
$log->error(string $text)
Wire or WireLogRecord an error message in the error log (errors.txt)
$log->message(string $text)
Wire or WireLogRecord an informational or 'success' message in the message log (messages.txt)
$log->save(string $name, string $text)
boolSave text to a named log
$log->warning(string $text)
Wire or WireLogRecord a warning message in the warnings log (warnings.txt)

Retrieval

NameReturnSummary 
$log->getEntries(string $name)
arrayReturn given number of entries from end of log file, with each entry as an associative array of components
$log->getFilename(string $name)
stringGet the full filename (including path) for the given log name
$log->getLines(string $name)
arrayReturn the given number of entries from the end of log file
$log->getLogs()
arrayReturn array of all logs, sorted by name
$log->getTotalEntries(string $name)
intGet the total number of entries present in the given log

Manipulation

NameReturnSummary 
$log->delete(string $name)
boolDelete a log file
$log->prune(string $name, int $days)
intPrune log file to contain only entries from last [n] days

Additional methods and properties

In addition to the methods and properties above, WireLog also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.83