InputfieldFile::processItemInputfields()

Process custom Inputfields for Pagefile item

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Available since version 3.0.142.

Internal usage

$bool = $inputfieldFile->processItemInputfields(Pagefile $pagefile, InputfieldWrapper $inputfields, string $id, WireInputData $input);

Arguments

NameType(s)Description
$pagefilePagefile
$inputfieldsInputfieldWrapper
$idstring

Pagefile ID string

$inputWireInputData

Return value

bool

True if changes detected, false if not


Hooking InputfieldFile::processItemInputfields(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $pagefile = $event->arguments(0);
  $inputfields = $event->arguments(1);
  $id = $event->arguments(2);
  $input = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $pagefile);
  $event->arguments(1, $inputfields);
  $event->arguments(2, $id);
  $event->arguments(3, $input);
});

Hooking after

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

$this->addHookAfter('InputfieldFile::processItemInputfields', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldFile = $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)
  $pagefile = $event->arguments(0);
  $inputfields = $event->arguments(1);
  $id = $event->arguments(2);
  $input = $event->arguments(3);

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

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

InputfieldFile methods and properties

API reference based on ProcessWire core version 3.0.251