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

Twitter updates

  • New post: ProcessWire 3.0.131 adds support for partial/resumable downloads and http stream delivery, and contains several updates to our comments system, among other updates— More
    3 May 2019
  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019

Latest news

  • ProcessWire Weekly #262
    The 262nd issue of ProcessWire Weekly will cover the latest module updates, both Pro modules and non-commercial ones. We've also got some highlights from the support forum, and a beautiful new site of the week. Read on!
    Weekly.pw / 18 May 2019
  • Lots of module updates
    In this post we take a quick look at the new version of ProFields Repeater Matrix, yet another new version of FormBuilder, and a new version of the GoogleClientAPI module.
    Blog / 17 May 2019
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.