ProcessModule class

List, edit or install/uninstall modules

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.

Common

Name	Return	Summary
ProcessModule::buildDownloadConfirmForm() ProcessModule::buildDownloadConfirmForm(array $data) ProcessModule::buildDownloadConfirmForm(array $data, $update = false)	`InputfieldForm`
ProcessModule::buildDownloadSuccessForm() ProcessModule::buildDownloadSuccessForm($className) ProcessModule::buildDownloadSuccessForm($className)	`InputfieldForm`
ProcessModule::execute() ProcessModule::execute() ProcessModule::execute()	`string` `array`	Load all modules, install any requested, and render a list of all modules
ProcessModule::executeDownload() ProcessModule::executeDownload() ProcessModule::executeDownload()	`string`	Triggered on the /download/ action - Downloads a module from the directory
ProcessModule::executeDownloadURL() ProcessModule::executeDownloadURL() ProcessModule::executeDownloadURL($url = '')	(nothing)
ProcessModule::executeEdit() ProcessModule::executeEdit() ProcessModule::executeEdit()	(nothing)	Load the form for editing a module's settings
ProcessModule::executeInstallConfirm() ProcessModule::executeInstallConfirm() ProcessModule::executeInstallConfirm()	(nothing)
ProcessModule::executeNavJSON() ProcessModule::executeNavJSON() ProcessModule::executeNavJSON(array $options = [])	`string`	Output JSON list of navigation items for this (intended to for ajax use)
ProcessModule::executeReadme() ProcessModule::executeReadme() ProcessModule::executeReadme()	`string`	Execute view of supported README type markdown or txt file
ProcessModule::executeTranslation() ProcessModule::executeTranslation() ProcessModule::executeTranslation()	`string`	Languages translations import
ProcessModule::executeUpload() ProcessModule::executeUpload() ProcessModule::executeUpload($inputName = '')	(nothing)
ProcessModule::getAfterLoginUrl() ProcessModule::getAfterLoginUrl(Page $page) 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() ProcessModule::installer() ProcessModule::installer()	`ProcessModuleInstall`	@return ProcessModuleInstall
ProcessModule::wired() ProcessModule::wired() ProcessModule::wired()	(nothing)	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.236

List, edit or install/uninstall modules

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news