$modulesrefresh()

Refresh the modules cache

This forces the modules file and information cache to be re-created.

Usage

// basic usage
$modules->refresh();
// usage with all arguments
$modules->refresh(bool $showMessages = false);

Arguments

NameType(s)Description
$showMessages (optional)bool

Show notification messages about what was found? Default:false 3.0.172+


Hooking $modules→refresh(...)

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

$this->addHookBefore('Modules::refresh', 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)
 $showMessages = $event->arguments(0);
 /* Your code here, perhaps modifying arguments */
 // Populate back arguments (if you have modified them)
 $event->arguments(0, $showMessages);
});

Hooking after

The 'after' hooks are called immediately after each $modules->refresh(...) 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::refresh', 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)
 $showMessages = $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.267

AltStyle によって変換されたページ (->オリジナル) /