InputfieldImage::renderList()

Render list of images

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

Internal usage

$string = $inputfieldImage->renderList($value);

Arguments

NameType(s)Description
$valuePageimages array

Return value

string

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking InputfieldImage::renderList(…)

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

$this->addHookBefore('InputfieldImage::renderList', 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)
  $value = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each InputfieldImage::renderList(…) 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::renderList', 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)
  $value = $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.251