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::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.137

Twitter updates

  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019
  • ProcessWire 3.0.144 core updates: Upgraded overrides section in the field editor, a new Inputfields JS API, and more— More
    1 November 2019
  • ProcessWire 3.0.143 core updates — 26 commits and 18 resolved issue reports, plus some other useful improvements and additions. More here: More
    25 October 2019

Newest forum posts

Latest news

  • ProcessWire Weekly #287
    In the 287th issue of ProcessWire Weekly we'll talk a bit about the latest core versions 3.0.144 and 3.0.145, introduce a third party module called Sanitizer EasySlugger, and publish a new #processwireworks poll. Read on!
    Weekly.pw / 9 November 2019
  • ProcessWire 3.0.145 core updates
    ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core.
    Blog / 8 November 2019
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer