InputfieldCheckbox::render() method

Render checkbox input

This is an abstract method that descending Inputfield module classes are required to implement.

Usage

$string = $inputfieldCheckbox->render();

Return value

string


Hooking InputfieldCheckbox::render()

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

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

$this->addHookAfter('InputfieldCheckbox::render', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldCheckbox = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

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

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

InputfieldCheckbox methods and properties

API reference based on ProcessWire core version 3.0.244

“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