ProcessModule class

Provides list, install, and uninstall capability for ProcessWire modules

For more details about how Process modules work, please see: wire/core/Process.php

This version also lifts several pieces of code from Soma's Modules Manager specific to the parts involved with downloading modules from the directory.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessModule class also inherits all the methods and properties of: Process, WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ProcessModule::execute()
None

Load all modules, install any requested, and render a list of all modules

ProcessModule::executeDownload()
string

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

ProcessModule::executeDownloadURL()
None
ProcessModule::executeEdit()
None

Load the form for editing a module's settings

ProcessModule::executeInstallConfirm()
None
ProcessModule::executeNavJSON()
string

Output JSON list of navigation items for this (intended to for ajax use)

ProcessModule::executeReadme()
string

Execute view of supported README type markdown or txt file

ProcessModule::executeTranslation()
string

Languages translations import

ProcessModule::executeUpload()
None
ProcessModule::getAfterLoginUrl(Page $page)
string

URL to redirect to after non-authenticated user is logged-in, or false if module does not support

 
ProcessModule::installer()
ProcessModuleInstall

@return ProcessModuleInstall

 
ProcessModule::wired()
None

Wired to API

 

Additional methods and properties

In addition to the methods and properties above, ProcessModule also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.253