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.155

Twitter updates

  • This post covers a few of the bigger updates in ProcessWire 3.0.154+3.0.155. This includes new live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our input->urlSegment() method! More
    24 April 2020
  • A brief look at what's new in ProcessWire 3.0.154 in this forum post: More
    17 April 2020
  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020

Latest news

  • ProcessWire Weekly #311
    In the 311th issue of ProcessWire Weekly we're going to talk a bit about the latest dev versions of ProcessWire, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 25 April 2020
  • ProcessWire 3.0.154 and 3.0.155 core updates
    This post covers a few of the bigger updates in ProcessWire 3.0.154 and 3.0.155 on the dev branch. This includes a new function for live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our $input->urlSegment() method that I think you’ll like!
    Blog / 24 April 2020
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer