$fileslog()

Log a message for this class

Usage

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

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

Arguments

NameType(s)Description
$str (optional)string

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

$options (optional)array

Optional extras to include, see Wire::___log()

Return value


Hooking $files→log(…)

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

$this->addHookBefore('WireFileTools::log', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $files = $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 $files->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('WireFileTools::log', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $files = $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;
});

$files methods and properties

API reference based on ProcessWire core version 3.0.251