InputfieldImage::getImageThumbnailActions() method

Get the image thumbnail icon actions/links/buttons

These are icon-only actions/links displayed next to the trash icon when hovering over an image preview. They are also displayed as icons on the far right side of a image when in full list mode.

Example:

Available since version 3.0.212.

Example

$wire->addHookAfter('InputfieldImage::getImageThumbnailActions', function(HookEvent $event) {
  $image = $event->arguments(0); // Pageimage
  $class = $event->arguments(3); // class to use on all returned actions
  $a = $event->return; // array
  $a['download'] = "<a class='$class' href='$pagefile->url' download><span class='fa fa-download'></span></a>";
  $event->return = $a;
});

Usage

$array = $inputfieldImage->getImageThumbnailActions(Pageimage $pagefile, string $id, int $n, string $class);

Arguments

Name	Type(s)	Description
`pagefile`	Pageimage
`id`	string	Image id string
`n`	int	Image index number
`class`	string	Class that should appear on all returned actions/links/buttons

Return value

array

Hooking InputfieldImage::getImageThumbnailActions(…)

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

$this->addHookBefore('InputfieldImage::getImageThumbnailActions', 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);
  $id = $event->arguments(1);
  $n = $event->arguments(2);
  $class = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each InputfieldImage::getImageThumbnailActions(…) 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::getImageThumbnailActions', 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);
  $id = $event->arguments(1);
  $n = $event->arguments(2);
  $class = $event->arguments(3);

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