InputfieldCheckbox::processInput() method

Process input

This method should pull the value from the given $input argument, sanitize/validate it, and populate it to the value attribute of this Inputfield.

Inputfield modules should implement this method if the built-in one here doesn't solve their need. If this one does solve their need, then they should add any additional sanitization or validation to the Inputfield::setAttribute('value', $value) method to occur when given the value attribute.

Usage

$inputfieldCheckbox->processInput(WireInputData $input);

Arguments

Name	Type(s)	Description
`input`	WireInputData	User input where value should be pulled from (typically `$input->post`)

Return value

$this

Object instance it was called from (method supports fluent interface).

Hooking InputfieldCheckbox::processInput(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

InputfieldCheckbox methods and properties

API reference based on ProcessWire core version 3.0.236