SystemUpdater::coreVersionChange()

Hook called when the core version changes, in case any listeners want it

Note that version change is only detected when a page from the admin is viewed. To hook this, hook to "SystemUpdater::coreVersionChange"

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Internal usage

$systemUpdater->coreVersionChange(string $fromVersion, string $toVersion);

Arguments

NameType(s)Description
$fromVersionstring
$toVersionstring

Hooking SystemUpdater::coreVersionChange(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each SystemUpdater::coreVersionChange(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('SystemUpdater::coreVersionChange', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $SystemUpdater = $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)
  $fromVersion = $event->arguments(0);
  $toVersion = $event->arguments(1);

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

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

SystemUpdater methods and properties

API reference based on ProcessWire core version 3.0.257