InputfieldImage::renderAdditionalFields() method

Render any additional fields (for hooks)

Usage

$inputfieldImage->renderAdditionalFields($pagefile, string $id, int $n);

Arguments

NameType(s)Description
pagefilePageimage, Pagefile
idstring
nint

Hooking InputfieldImage::renderAdditionalFields(…)

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

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

  /* 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);
});

Hooking after

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

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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH