Process::installPage() method

Install a dedicated page for this Process module and assign it this Process

To be called by Process module's ___install() method.

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

Internal usage

// basic internal usage
$page = $this->installPage();

// internal usage with all arguments
$page = $this->installPage(string $name = '', $parent = null, string $title = '', $template = 'admin', array $extras = []);

Arguments

Name	Type(s)	Description
`$name` (optional)	`string`	Desired name of page, or omit (or blank) to use module name
`$parent` (optional)
`$title` (optional)	`string`	Omit or blank to pull title from module information
`$template` (optional)
`$extras` (optional)	`array`	Any extra properties to assign (like status)

Return value

Page

Returns the page that was created

Exceptions

Method can throw exceptions on error:

WireException - if page can't be created

Hooking $this→installPage(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $name = $event->arguments(0);
  $parent = $event->arguments(1);
  $title = $event->arguments(2);
  $template = $event->arguments(3);
  $extras = $event->arguments(4);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $name);
  $event->arguments(1, $parent);
  $event->arguments(2, $title);
  $event->arguments(3, $template);
  $event->arguments(4, $extras);
});

Hooking after

The 'after' hooks are called immediately after each $this->installPage(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Process::installPage', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Process = $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)
  $name = $event->arguments(0);
  $parent = $event->arguments(1);
  $title = $event->arguments(2);
  $template = $event->arguments(3);
  $extras = $event->arguments(4);

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

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

Process methods and properties

API reference based on ProcessWire core version 3.0.251