$modulesmoduleVersionChanged()

Hook called when a module's version changes

This calls the module's ___upgrade($fromVersion, $toVersion) method.

Usage

$modules->moduleVersionChanged($module, $fromVersion, $toVersion);

Arguments

NameType(s)Description
$moduleModule _Module
$fromVersionint string
$toVersionint string

Hooking $modules→moduleVersionChanged(…)

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

$this->addHookBefore('Modules::moduleVersionChanged', 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)
  $module = $event->arguments(0);
  $fromVersion = $event->arguments(1);
  $toVersion = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $module);
  $event->arguments(1, $fromVersion);
  $event->arguments(2, $toVersion);
});

Hooking after

The 'after' hooks are called immediately after each $modules->moduleVersionChanged(…) 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::moduleVersionChanged', 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)
  $module = $event->arguments(0);
  $fromVersion = $event->arguments(1);
  $toVersion = $event->arguments(2);

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