$log API variable / WireLog class

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.

Show $var?             Show args?        

Common

NameReturnSummary 
$log->disable(string $name)
selfDisable the given log name temporarily so that save() calls do not record entries during this request 
$log->enable(string $name)
selfEnable a previously disabled log 
$log->error(string $text)
Wire WireLogRecord an error message in the error log (errors.txt) 
$log->message(string $text)
Wire 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 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.163

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #332
    In the 332nd issue of ProcessWire Weekly we'll cover the latest core updates, introduce some new and updated ProcessWire resources, and more. Read on!
    Weekly.pw / 19 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH