ProcessModule::executeDownload() method

Triggered on the /download/ action - Downloads a module from the directory

Most code lifted from Soma's Modules Manager

Usage

$string = $processModule->executeDownload();

Return value

string

Rendered output or redirect

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking ProcessModule::executeDownload()

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

$this->addHookBefore('ProcessModule::executeDownload', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessModule = $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 ProcessModule::executeDownload() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

ProcessModule methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #548
    In the 548th issue of ProcessWire Weekly we're going to check out a couple of new third party modules, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 9 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

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull