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

Twitter updates

  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020
  • 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

Latest news

  • ProcessWire Weekly #336
    In the 336th issue of ProcessWire Weekly we're going to introduce the Stripe action for FormBuilder, highlight some recent forum topics and other online resources, and more. Read on!
    Weekly.pw / 17 October 2020
  • Stripe Payment Processor for FormBuilder
    This week a second new module for processing Stripe payments has been added to FormBuilder. We’ll take a closer look at it in this blog post, plus we’ve got a demo of it here too.
    Blog / 16 October 2020
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits