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 / Views / Module interface / For hooks

Common

Name Return Summary  
Process::breadcrumb(string $href, string $label) $this Add a breadcrumb
Process::browserTitle(string $title) $this Set the current browser title tag
Process::execute() string or array Execute this Process and return the output. You may have any number of execute[name] methods, triggered by URL segments.
Process::headline(string $headline) $this Set the current primary headline to appear in the admin interface

Views

Applicable only to Process modules that are using external output/view files.

Name Return Summary  
Process::getViewFile() string If a view file has been set, this returns the full path to it.
Process::getViewVars() array Get all variables set for the output view
Process::setViewFile(string $file) $this Set the file to use for the output view, if different from default.
Process::setViewVars($key) $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() (nothing) Per the Module interface, Install the module
Process::uninstall() (nothing) Uninstall this Process
Process::upgrade($fromVersion, $toVersion) (nothing) Called when module version changes

For hooks

This methods are only useful for hooking and should not be called directly.

Name Return Summary  
Process::executed(string $method) (nothing) Hookable method automatically called after execute() method has finished.
Process::installPage() Page Install a dedicated page for this Process module and assign it this Process
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: