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.

Show class?             Show args?        

Common

NameReturnSummary 
Process::breadcrumb(string $href, string $label)
$thisAdd a breadcrumb
Process::browserTitle(string $title)
$thisSet the current browser title tag
Process::execute()
string arrayExecute this Process and return the output. You may have any number of execute[name] methods, triggered by URL segments.
Process::executeUnknown()
string arrayCalled when urlSegment matches no execute[Method], only if implemented.
Process::getAfterLoginUrl(Page $page)
bool stringURL to redirect to after non-authenticated user is logged-in, or false if module does not support 
Process::getProcessPage()
Page NullPageReturn the Page that this process lives on 
Process::headline(string $headline)
$thisSet the current primary headline to appear in the admin interface
Process::ready()
(nothing)
Process::setConfigData(array $data)
(nothing)

Views

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

NameReturnSummary 
Process::getViewFile()
stringIf a view file has been set, this returns the full path to it. 
Process::getViewVars()
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. 
Process::setViewVars($key)
$thisSet a variable that will be passed to the output view. 

Module interface

See the Module interface for full details on these methods.

NameReturnSummary 
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

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

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

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer