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.123

Twitter updates

  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019
  • New ProcessWire main site rebuild ready for preview— More
    4 January 2019
  • Happy Holidays! This latest master version of ProcessWire contains hundreds of new additions, fixes, optimizations and more. This post covers all the highlights— More
    21 December 2018

Latest news

  • ProcessWire Weekly #244
    In the 244th issue of ProcessWire Weekly we'll cover the latest core updates, introduce the new processwire.com site, ask a PHP version related question in the weekly poll, and showcase the site of an open source room bookings app. Read on!
    Weekly.pw / 12 January 2019
  • ProcessWire 3.0.124 and new website launched
    In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124.
    Blog / 11 January 2019
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani