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.

Usage

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

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

Arguments

NameType(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 Process::installPage(…)

You can add your own hook events that are executed either before or after the Process::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 Process::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 Process::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.178

Twitter updates

  • ProcessWire 3.0.181 has fixes and improvements as usual, but the biggest addition is a nice pull request for multi-language module translations, plus major updates to our Helloworld and ProcessHello demonstration modules. This post covers it all— More
    2 July 2021
  • ProcessWire 3.0.180 core updates– More
    18 June 2021
  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021

Latest news

  • ProcessWire Weekly #373
    In the 373rd issue of ProcessWire Weekly we're going to cover the latest core updates, check out a couple of brand new third party modules, and highlight a new site of the week. Read on!
    Weekly.pw / 4 July 2021
  • ProcessWire 3.0.181 core updates + “Hello World”
    ProcessWire 3.0.181 has fixes and improvements as usual, but the biggest addition is a nice pull request from LostKobrakai, plus major updates to our Helloworld and ProcessHello demonstration modules. This post covers it all.
    Blog / 2 July 2021
  • Subscribe to weekly ProcessWire news

“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