Process class

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.

There are 36 Process types in the core, plus many more Processs in the modules directory.

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

Name	Return	Summary
Process::breadcrumb() Process::breadcrumb(string $href, string $label) Process::breadcrumb(string $href, string $label)	`$this`	Add a breadcrumb
Process::browserTitle() Process::browserTitle(string $title) Process::browserTitle(string $title)	`$this`	Set the current browser title tag
Process::execute() Process::execute() Process::execute()	`string` `array`	Execute this Process and return the output. You may have any number of execute[name] methods, triggered by URL segments.
Process::executeNavJSON() Process::executeNavJSON() Process::executeNavJSON(array $options = [])	`string` `array`	Return JSON data of items managed by this Process for use in navigation
Process::executeUnknown() Process::executeUnknown() Process::executeUnknown()	`string` `array`	Called when urlSegment matches no execute[Method], only if implemented.
Process::getAfterLoginUrl() Process::getAfterLoginUrl(Page $page) Process::getAfterLoginUrl(Page $page)	`bool` `string`	URL to redirect to after non-authenticated user is logged-in, or false if module does not support
Process::getProcessPage() Process::getProcessPage() Process::getProcessPage()	`Page` `NullPage`	Return the Page that this process lives on
Process::headline() Process::headline(string $headline) Process::headline(string $headline)	`$this`	Set the current primary headline to appear in the admin interface
Process::ready() Process::ready() Process::ready()	None
Process::setConfigData() Process::setConfigData(array $data) Process::setConfigData(array $data)	None

Views

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

Name	Return	Summary
Process::getViewFile() Process::getViewFile() Process::getViewFile()	`string`	If a view file has been set, this returns the full path to it.
Process::getViewVars() Process::getViewVars() Process::getViewVars()	`array`	Get all variables set for the output view
Process::setViewFile() Process::setViewFile(string $file) Process::setViewFile(string $file)	`$this`	Set the file to use for the output view, if different from default.
Process::setViewVars() Process::setViewVars($key) Process::setViewVars($key, $value = null)	`$this`	Set a variable that will be passed to the output view.

Module interface

See the Module interface for full details on these methods.

Name	Return	Summary
Process::install() Process::install() Process::install()	None	Per the Module interface, Install the module
Process::uninstall() Process::uninstall() Process::uninstall()	None	Uninstall this Process
Process::upgrade() Process::upgrade($fromVersion, $toVersion) Process::upgrade($fromVersion, $toVersion)	None	Called when module version changes

For hooks

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

Name	Return	Summary
Process::executed() Process::executed(string $method) Process::executed(string $method)	None	Hookable method automatically called after execute() method has finished.
$this->installPage() $this->installPage() $this->installPage(string $name = '', $parent = null, string $title = '', $template = 'admin', array $extras = [])	`Page`	Install a dedicated page for this Process module and assign it this Process
$this->uninstallPage() $this->uninstallPage() $this->uninstallPage()	`int`	Uninstall (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:

Core Process types

Type	Summary
ProcessCommentsManager	Manage comments in your site outside of the page editor.
ProcessField	Edit individual fields that hold page data
ProcessForgotPassword	Provides password reset/email capability for the Login process.
ProcessHome	Acts as a placeholder Process for the admin root. Ensures proper flow control after login.
ProcessList	Lists the Process assigned to each child page of the current
ProcessLogger	View and manage system logs.
ProcessLogin	Login to ProcessWire
ProcessModule	List, edit or install/uninstall modules
ProcessPageAdd	Add a new page
ProcessPageEdit	Edit a Page
ProcessPageEditImageSelect	Provides image manipulation functions for image fields and rich text editors.
ProcessPageEditLink	Provides a link capability as used by some Fieldtype modules (like rich text editors).
ProcessPageList	List pages in a hierarchical tree structure
ProcessPageLister	Admin tool for finding and listing pages by any property.
ProcessPageSearch	Provides a page search engine for admin use.
ProcessPageSort	Handles page sorting and moving for PageList
ProcessPageTrash	Handles emptying of Page trash
ProcessPageType	List, Edit and Add pages of a specific type
ProcessPageView	All page views are routed through this Process
ProcessPagesExportImport	Enables exporting and importing of pages. Development version, not yet recommended for production use.
ProcessPermission	Manage system permissions
ProcessProfile	Enables user to change their password, email address and other settings that you define.
ProcessRecentPages	Shows a list of recently edited pages in your admin.
ProcessRole	Manage user roles and what permissions are attached
ProcessTemplate	List and edit the templates that control page output
ProcessUser	Manage system users

API reference based on ProcessWire core version 3.0.251