ProcessPageType class

Manage, edit add pages of a specific type in ProcessWire

For more details about how Process modules work, please see: wire/core/Process.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessPageType class also inherits all the methods and properties of: Process, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
ProcessPageType::execute() ProcessPageType::execute() ProcessPageType::execute()	`string`	Main execution method, delegated to listing items in this page type
ProcessPageType::executeActions() ProcessPageType::executeActions() ProcessPageType::executeActions()	None
ProcessPageType::executeAdd() ProcessPageType::executeAdd() ProcessPageType::executeAdd()	`string`	Add item of this page type
ProcessPageType::executeConfig() ProcessPageType::executeConfig() ProcessPageType::executeConfig()	None
ProcessPageType::executeEdit() ProcessPageType::executeEdit() ProcessPageType::executeEdit()	`string`	Edit item of this page type
ProcessPageType::executeEditBookmark() ProcessPageType::executeEditBookmark() ProcessPageType::executeEditBookmark()	None
ProcessPageType::executeList() ProcessPageType::executeList() ProcessPageType::executeList()	`string`	List items in this page type
ProcessPageType::executeNavJSON() ProcessPageType::executeNavJSON() ProcessPageType::executeNavJSON(array $options = [])	`string` `array`	Output JSON list of navigation items for this (intended to for ajax use)
ProcessPageType::executeReset() ProcessPageType::executeReset() ProcessPageType::executeReset()	None
ProcessPageType::executeSave() ProcessPageType::executeSave() ProcessPageType::executeSave()	None
ProcessPageType::executeSaveTemplate() ProcessPageType::executeSaveTemplate() ProcessPageType::executeSaveTemplate()	`string`	Execute saving changes of the "change template" action delegated to ProcessPageEdit
ProcessPageType::executeTemplate() ProcessPageType::executeTemplate() ProcessPageType::executeTemplate()	`string`	Execute the "change template" action delegated to ProcessPageEdit
ProcessPageType::executeUnknown() ProcessPageType::executeUnknown() ProcessPageType::executeUnknown()	`string`	Catch-all for bookmarks
ProcessPageType::executeViewport() ProcessPageType::executeViewport() ProcessPageType::executeViewport()	None
ProcessPageType::getLister() ProcessPageType::getLister() ProcessPageType::getLister(string $selector = '')	`ProcessPageLister` `null`	Get an instanceof ProcessPageLister or null if not applicable
ProcessPageType::getPage() ProcessPageType::getPage() ProcessPageType::getPage()	`NullPage` `Page`	Get page being edited (for WirePageEditor interface)
ProcessPageType::search() ProcessPageType::search(string $text) ProcessPageType::search(string $text, array $options = [])	`array`	Search for items containing $text and return an array representation of them

Properties

Name	Return	Summary
ProcessPageType::addLabel	`string`	Translated "Add New" label
ProcessPageType::jsonListLabel	`string`	What to use for 'label' property in JSON nav data DEFAULT: 'name'
ProcessPageType::showFields	`array`	Names of fields to show in the main list table DEFAULT: ['name']

Additional methods and properties

In addition to the methods and properties above, ProcessPageType also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.253