$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->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.124

Twitter updates

  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019
  • New ProcessWire main site rebuild ready for preview— More
    4 January 2019
  • Happy Holidays! This latest master version of ProcessWire contains hundreds of new additions, fixes, optimizations and more. This post covers all the highlights— More
    21 December 2018

Latest news

  • ProcessWire Weekly #245
    In the 245th issue of ProcessWire Weekly we're going to focus on some new documentation additions made just this week, cover a couple of new third party modules from Bernhard Baumrock, and introduce a magnificent new travel website called Uncover Colombia. Read on!
    Weekly.pw / 19 January 2019
  • ProcessWire 3.0.124 and new website launched
    In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124.
    Blog / 11 January 2019
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer