InputfieldImage::getFileActions() method

Get array of actions (displayed in select dropdown) available for given Pagefile

Example

// Example of adding an “Get EXIF data” action
$wire->addHookAfter('InputfieldImage::getFileActions', function(HookEvent $event) {
  $image = $event->arguments(0); // Pageimage
  if($image->ext == 'jpg' || $image->ext == 'jpeg') {
    $actions = $event->return; // array
    $actions['exif'] = 'Get EXIF data';
    $event->return = $actions;
  }
});

// Example of handling an “Get EXIF data” action
$wire->addHookAfter('InputfieldImage::processUnknownFileAction', function(HookEvent $event) {
  $image = $event->arguments(0);
  $action = $event->arguments(1);
  if($action === 'exif') {
    $exif = exif_read_data($image->filename);
    $event->warning([ "EXIF data for $image->name" => $exif ], 'icon-photo nogroup');
    $event->return = true;
  }
});

Usage

$array = $inputfieldImage->getFileActions($pagefile);

Arguments

Name	Type(s)	Description
`pagefile`	Pagefile, Pageimage

Return value

array

Associative array of ('action_name' => 'Action Label')

Hooking InputfieldImage::getFileActions(…)

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

$this->addHookBefore('InputfieldImage::getFileActions', 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);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each InputfieldImage::getFileActions(…) 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::getFileActions', 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);

  /* 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.236