ProcessPageType class

List, Edit and Add pages of a specific type

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?        

Common

NameReturnSummary 
ProcessPageType::addLabel string Translated "Add New" label 
ProcessPageType::execute()
stringMain execution method, delegated to listing items in this page type
ProcessPageType::executeActions()
(nothing)
ProcessPageType::executeAdd()
stringAdd item of this page type
ProcessPageType::executeConfig()
(nothing)
ProcessPageType::executeEdit()
stringEdit item of this page type
ProcessPageType::executeEditBookmark()
(nothing)
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()
(nothing)
ProcessPageType::executeSave()
(nothing)
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()
(nothing)
ProcessPageType::getLister()
ProcessPageLister nullGet an instanceof ProcessPageLister or null if not applicable 
ProcessPageType::getPage()
NullPage PageGet page being edited (for WirePageEditor interface) 
ProcessPageType::jsonListLabel string What to use for 'label' property in JSON nav data (default='name') 
ProcessPageType::search(string $text)
arraySearch for items containing $text and return an array representation of them 
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.236

Latest news

  • ProcessWire Weekly #557
    In the 557th issue of ProcessWire Weekly we're going to share the latest core development news, introduce a new third party module, and more. Read on!
    Weekly.pw / 12 January 2025
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer