$sanitizercallUnknown()

Map to sanitizers

Usage

$string = $sanitizer->callUnknown($method, $arguments);

Arguments

NameType(s)Description
$method
$arguments

Return value

string int array float null

Returns null when input variable does not exist

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $sanitizer→callUnknown(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.251