InputfieldWrapper::allowProcessInput()

Allow input to be processed for given Inputfield? (for hooks)

IMPORTANT: This method is not called unless it is hooked! Descending classes should instead implement the isProcessable() method (when needed) and be sure to call the parent isProcessable() method too.

Available since version 3.0.207.

Usage

$bool = $inputfieldWrapper->allowProcessInput(Inputfield $inputfield);

Arguments

NameType(s)Description
$inputfieldInputfield

Return value

bool


Hooking InputfieldWrapper::allowProcessInput(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

InputfieldWrapper methods and properties

API reference based on ProcessWire core version 3.0.252