InputfieldPageAutocomplete::renderListItem()

Render a selected list item

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Internal usage

// basic internal usage
$string = $inputfieldPageAutocomplete->renderListItem(string $label, string $value);

// internal usage with all arguments
$string = $inputfieldPageAutocomplete->renderListItem(string $label, string $value, string $class = '');

Arguments

NameType(s)Description
$labelstring
$valuestring
$class (optional)string

Return value

string


Hooking InputfieldPageAutocomplete::renderListItem(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $label = $event->arguments(0);
  $value = $event->arguments(1);
  $class = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $label);
  $event->arguments(1, $value);
  $event->arguments(2, $class);
});

Hooking after

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

$this->addHookAfter('InputfieldPageAutocomplete::renderListItem', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldPageAutocomplete = $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)
  $label = $event->arguments(0);
  $value = $event->arguments(1);
  $class = $event->arguments(2);

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

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

InputfieldPageAutocomplete methods and properties

API reference based on ProcessWire core version 3.0.251