$log->save() method

Save text to a named log

  • If the log doesn't currently exist, it will be created.
  • The log filename is /site/assets/logs/[name].txt
  • Logs can be viewed in the admin at Setup > Logs

Example

// Save text searches to custom log file (search.txt):
$log->save("search", "User searched for: $phrase");

Usage

// basic usage
$bool = $log->save(string $name, string $text);

// usage with all arguments
$bool = $log->save(string $name, string $text, array $options = []);

Arguments

NameType(s)Description
namestring

Name of log to save to (word consisting of only [-._a-z0-9] and no extension)

textstring

Text to save to the log

options (optional)array

Options to modify default behavior:

  • showUser (bool): Include the username in the log entry? (default=true)
  • showURL (bool): Include the current URL in the log entry? (default=true)
  • user (User|string|null): User instance, user name, or null to use current User. (default=null)
  • url (bool): URL to record with the log entry (default=auto determine)
  • delimiter (string): Log entry delimiter (default="\t" aka tab)

Return value

bool

Whether it was written or not (generally always going to be true)

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $log->save(…)

You can add your own hook events that are executed either before or after the $log->save(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $log->save(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireLog::save', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $log = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $name = $event->arguments(0);
  $text = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $name);
  $event->arguments(1, $text);
  $event->arguments(2, $options);
});

Hooking after

The 'after' hooks are called immediately after each $log->save(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireLog::save', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $log = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $name = $event->arguments(0);
  $text = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$log methods and properties

API reference based on ProcessWire core version 3.0.178

Twitter updates

  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021

Latest news

  • ProcessWire Weekly #370
    In the 370th issue of ProcessWire Weekly we're going to check out the latest version of the commercial FormBuilder module, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 12 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.