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.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ProcessPageType::execute()
stringMain execution method, delegated to listing items in this page type
ProcessPageType::executeActions()
None
ProcessPageType::executeAdd()
stringAdd item of this page type
ProcessPageType::executeConfig()
None
ProcessPageType::executeEdit()
stringEdit item of this page type
ProcessPageType::executeEditBookmark()
None
ProcessPageType::executeList()
stringList items in this page type
ProcessPageType::executeNavJSON()
string arrayOutput JSON list of navigation items for this (intended to for ajax use)
ProcessPageType::executeReset()
None
ProcessPageType::executeSave()
None
ProcessPageType::executeSaveTemplate()
stringExecute saving changes of the "change template" action delegated to ProcessPageEdit
ProcessPageType::executeTemplate()
stringExecute the "change template" action delegated to ProcessPageEdit
ProcessPageType::executeUnknown()
stringCatch-all for bookmarks
ProcessPageType::executeViewport()
None
ProcessPageType::getLister()
ProcessPageLister nullGet an instanceof ProcessPageLister or null if not applicable 
ProcessPageType::getPage()
NullPage PageGet page being edited (for WirePageEditor interface) 
ProcessPageType::search(string $text)
arraySearch for items containing $text and return an array representation of them 

Properties

NameReturnSummaryDefault
ProcessPageType::addLabel string Translated "Add New" label 
ProcessPageType::jsonListLabel string What to use for 'label' property in JSON nav data 'name'
ProcessPageType::showFields array Names of fields to show in the main list table ['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.251