Process modules are self contained applications that run in the ProcessWire admin.
Please be sure to see the Module interface for full details on methods you can specify in a Process module.
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Process class also inherits all the methods and properties of: WireData and Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
Process::breadcrumb() Process::breadcrumb(string $href, string $label) Process::breadcrumb(string $href, string $label) | $this | Add a breadcrumb | |
Process::browserTitle() Process::browserTitle(string $title) Process::browserTitle(string $title) | $this | Set the current browser title tag | |
Process::execute() Process::execute() Process::execute() | string array | Execute this Process and return the output. You may have any number of execute[name] methods, triggered by URL segments. | |
Process::executeUnknown() Process::executeUnknown() Process::executeUnknown() | string array | Called when urlSegment matches no execute[Method], only if implemented. | |
Process::getAfterLoginUrl() Process::getAfterLoginUrl(Page $page) Process::getAfterLoginUrl(Page $page) | bool string | URL to redirect to after non-authenticated user is logged-in, or false if module does not support | |
Process::getProcessPage() Process::getProcessPage() Process::getProcessPage() | Page NullPage | Return the Page that this process lives on | |
Process::headline() Process::headline(string $headline) Process::headline(string $headline) | $this | Set the current primary headline to appear in the admin interface | |
Process::ready() Process::ready() Process::ready() | (nothing) | ||
Process::setConfigData() Process::setConfigData(array $data) Process::setConfigData(array $data) | (nothing) |
Views
Applicable only to Process modules that are using external output/view files.
| Name | Return | Summary | |
|---|---|---|---|
Process::getViewFile() Process::getViewFile() Process::getViewFile() | string | If a view file has been set, this returns the full path to it. | |
Process::getViewVars() Process::getViewVars() Process::getViewVars() | array | Get all variables set for the output view | |
Process::setViewFile() Process::setViewFile(string $file) Process::setViewFile(string $file) | $this | Set the file to use for the output view, if different from default. | |
Process::setViewVars() Process::setViewVars($key) Process::setViewVars($key, $value = null) | $this | Set a variable that will be passed to the output view. |
Module interface
See the Module interface for full details on these methods.
| Name | Return | Summary | |
|---|---|---|---|
Process::install() Process::install() Process::install() | (nothing) | Per the Module interface, Install the module | |
Process::uninstall() Process::uninstall() Process::uninstall() | (nothing) | Uninstall this Process | |
Process::upgrade() Process::upgrade($fromVersion, $toVersion) Process::upgrade($fromVersion, $toVersion) | (nothing) | Called when module version changes |
For hooks
These methods are only useful for hooking and should not be called directly.
| Name | Return | Summary | |
|---|---|---|---|
Process::executed() Process::executed(string $method) Process::executed(string $method) | (nothing) | Hookable method automatically called after execute() method has finished. | |
Process::installPage() Process::installPage() Process::installPage(string $name = '', $parent = null, string $title = '', $template = 'admin', array $extras = []) | Page | Install a dedicated page for this Process module and assign it this Process | |
Process::uninstallPage() Process::uninstallPage() Process::uninstallPage() | int | Uninstall (trash) dedicated pages for this Process module |
Additional methods and properties
In addition to the methods and properties above, Process also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.244