Inputfield::renderReadyHook() method

Hookable version of renderReady(), not called unless 'renderReadyHook' is hooked

Hook this method instead if you want to hook renderReady().

Usage

// basic usage
$inputfield->renderReadyHook();

// usage with all arguments
$inputfield->renderReadyHook(Inputfield $parent = null, bool $renderValueMode = false);

Arguments

NameType(s)Description
parent (optional)Inputfield
renderValueMode (optional)bool

Hooking Inputfield::renderReadyHook(…)

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

$this->addHookBefore('Inputfield::renderReadyHook', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Inputfield = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $parent = $event->arguments(0);
  $renderValueMode = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each Inputfield::renderReadyHook(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Inputfield::renderReadyHook', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Inputfield = $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)
  $parent = $event->arguments(0);
  $renderValueMode = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

Inputfield methods and properties

API reference based on ProcessWire core version 3.0.214

Twitter updates

  • This week ProcessWire 3.0.214 is on the dev branch. Relative to 3.0.213 this version has 16 new commits which include the addition of 3 new pull requests, 6 issue fixes, a new WireNumberTools utility class, and various other improvements. More
    17 March 2023
  • ProcessWire 3.0.213 core updates: This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields. More
    24 February 2023
  • ProcessWire 3.0.212 core updates— More
    17 February 2023

Latest news

  • ProcessWire Weekly #462
    In the 462nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a new third party module called Template Access Log, and more. Read on!
    Weekly.pw / 18 March 2023
  • ProcessWire 3.0.213 core updates
    This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields.
    Blog / 24 February 2023
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer