Wire::log() method

Log a message for this class

Message is saved to a log file in ProcessWire's logs path to a file with the same name as the class, converted to hyphenated lowercase. For example, a class named MyWidgetData would have a log named my-widget-data.txt.

Example

$this->log("This message will be logged");

Usage

// basic usage
$wireLog = $wire->log();

// usage with all arguments
$wireLog = $wire->log(string $str = '', array $options = []);

Arguments

Name Type(s) Description

Name	Type(s)	Description
`str` (optional)	string	Text to log, or omit to return the `$log` API variable.
`options` (optional)	array	Optional extras to include: `url` (string): URL to record the with the log entry (default=auto-detect) `name` (string): Name of log to use (default=auto-detect) `user` (User\|string\|null): User instance, user name, or null to log for current User. (default=null)

str (optional)

string

Text to log, or omit to return the $log API variable.

options (optional)

array

Optional extras to include:

url (string): URL to record the with the log entry (default=auto-detect)
name (string): Name of log to use (default=auto-detect)
user (User|string|null): User instance, user name, or null to log for current User. (default=null)

Return value

WireLog

Hooking Wire::log(…)

You can add your own hook events that are executed either before or after the Wire::log(…) 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 Wire::log(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('Wire::log', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Wire = $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)
  $str = $event->arguments(0);
  $options = $event->arguments(1);

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

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

Wire methods and properties

API reference based on ProcessWire core version 3.0.244