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

Show “Process”             Show Arguments        


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


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

stringIf a view file has been set, this returns the full path to it.
arrayGet all variables set for the output view
Process::setViewFile(string $file)
$thisSet the file to use for the output view, if different from default.
$thisSet a variable that will be passed to the output view.

Module interface

See the Module interface for full details on these methods.

(nothing)Per the Module interface, Install the module
(nothing)Uninstall this Process
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.

Process::executed(string $method)
(nothing)Hookable method automatically called after execute() method has finished.
PageInstall a dedicated page for this Process module and assign it this Process
intUninstall (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.84