Process::uninstallPage() method

Uninstall (trash) dedicated pages for this Process module

If there is more than one page using this Process, it will trash them all.

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

Usage

$int = $process->uninstallPage();

Return value

int

Number of pages trashed


Hooking Process::uninstallPage()

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

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

  /* 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.236

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • 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