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

Name	Type(s)	Description
`inputfield`	Inputfield	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.236