ProcessPageLister::execute() method

Execute the main Lister action, which is to render the Lister

When any execute() method returns a string, it us used as the actual output. When the method returns an associative array, it is considered an array of variables to send to the output view layer. Returned array must not be empty, otherwise it cannot be identified as an associative array.

This execute() method is called when no URL segments are present. You may have any number of execute() methods, i.e. executeFoo() would be called for the URL ./foo/ and executeBarBaz() would be called for the URL ./bar-baz/.

Usage

$string = $processPageLister->execute();

Return value

string

Hooking ProcessPageLister::execute()

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

$this->addHookBefore('ProcessPageLister::execute', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessPageLister = $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 ProcessPageLister::execute() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

ProcessPageLister methods and properties

API reference based on ProcessWire core version 3.0.236