InputfieldImage::processUnknownFileAction() method

Called when a select dropdown action was received that InputfieldImage does not recognize (for hooking purposes)

This is what should be hooked to provide the processing for a custom action added from a hook. See the ___getFileActions() method documentation for full example including both hooks.

Usage

$bool = $inputfieldImage->processUnknownFileAction(Pageimage $pagefile, string $action, string $label);

Arguments

NameType(s)Description
pagefilePageimage

Image file to process

actionstring

Action to execute

labelstring

Label that was provided to describe action

Return value

bool null

Returns true on success, false on fail, or null if action was not handled or recognized


Hooking InputfieldImage::processUnknownFileAction(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('InputfieldImage::processUnknownFileAction', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldImage = $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);
  $action = $event->arguments(1);
  $label = $event->arguments(2);

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

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

InputfieldImage methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer