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

Twitter updates

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #296
    In the 296th issue of ProcessWire Weekly we're going to introduce the newly released front-end file uploads support for LoginRegisterPro, introduce a couple of third party modules, and more. Read on!
    Weekly.pw / 11 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK