InputfieldImage::getImageEditButtons() method

Get array of buttons for image edit mode

Hook after this to add or remove image edit buttons/actions.

Available since version 3.0.212.

Example

// Example of adding a download button
$wire->addHookAfter('InputfieldImage::getImageEditButtons', function(HookEvent $event) {
  $image = $event->arguments(0); // Pageimage
  $class = $event->arguments(3);
  $buttons = $event->return; // array
  $icon = wireIconMarkup('download');
  $buttons['download'] = "<button class='$class'><a download href='$image->url'>$icon Download</a></button>";
  $event->return = $buttons;
});

Usage

$array = $inputfieldImage->getImageEditButtons($pagefile, string $id, int $n, string $buttonClass);

Arguments

Name	Type(s)	Description
`pagefile`	Pagefile, Pageimage	Image that buttons are for
`id`	string	Image/file id
`n`	int	Index of image/file (i.e 0=first)
`buttonClass`	string	Class attribute additions that should appear on all returned

Return value

array

Array of

Hooking InputfieldImage::getImageEditButtons(…)

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

$this->addHookBefore('InputfieldImage::getImageEditButtons', 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);
  $buttonClass = $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, $buttonClass);
});

Hooking after

The 'after' hooks are called immediately after each InputfieldImage::getImageEditButtons(…) 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::getImageEditButtons', 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);
  $buttonClass = $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.236