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.137

Twitter updates

  • New post: An introductory look at ProcessWire LoginRegisterPro, a module for providing new user registration, secure logins, profile editing, and more— More
    13 December 2019
  • ProcessWire 3.0.146 on the dev branch contains about 22 commits with a combination of useful upgrades and issue report resolutions, more details in this forum post: More
    22 November 2019
  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019

Latest news

  • ProcessWire Weekly #291
    In the 291st issue of ProcessWire Weekly we're going to take a closer look at the latest core updates, check out a brand new third party module called ProcessHelpVideos, and introduce a new site of the week. Read on!
    Weekly.pw / 8 December 2019
  • Login Register Pro
    This week we’ll take a look at LoginRegisterPro — a new module that provides an all-in-one, self contained module for providing new user registration, secure logins, profile editing, and more. It does this all in a manner that is reliable, efficient, comprehensive and secure.
    Blog / 13 December 2019
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer