$modules->uninstall() method

Uninstall the given module name

Usage

$bool = $modules->uninstall(string $class);

Arguments

NameType(s)Description
classstring

Module name (class name)

Return value

bool

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $modules->uninstall(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $class = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $class);
});

Hooking after

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

$this->addHookAfter('Modules::uninstall', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $modules = $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)
  $class = $event->arguments(0);

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

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

$modules methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 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

“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