InputfieldWrapper::renderInputfield() method

Render output for an individual Inputfield

This method takes care of all the pre-and-post requisites needed for rendering an Inputfield among a group of Inputfields. It is used by the InputfieldWrapper::render() method for each Inputfield present in the children.

Usage

// basic usage
$string = $inputfieldWrapper->renderInputfield(Inputfield $inputfield);

// usage with all arguments
$string = $inputfieldWrapper->renderInputfield(Inputfield $inputfield, bool $renderValueMode = false);

Arguments

NameType(s)Description
inputfieldInputfield

The Inputfield to render.

renderValueMode (optional)bool

Specify true if we are only rendering values (default=false).

Return value

string

Rendered output


Hooking InputfieldWrapper::renderInputfield(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('InputfieldWrapper::renderInputfield', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldWrapper = $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)
  $inputfield = $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;
});

InputfieldWrapper methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022
  • New post: ProcessWire now comes with just 1 site installation profile, the "blank" profile. It makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it— More
    10 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Starting a site with the “blank” profile
    ProcessWire 3.0.200+ comes with just 1 site installation profile, the site-blank profile. This profile makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it. 
    Blog / 10 June 2022
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits