ProcessPageEdit class

Edit a Page

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

Show class?             Show args?        

Common

NameReturnSummary 
ProcessPageEdit::addTab(string $id, string $label)
(nothing)Add a tab with HTML id attribute and label 
ProcessPageEdit::ajaxEditable(Page $page)
bool
ProcessPageEdit::ajaxSave(Page $page)
(nothing)
ProcessPageEdit::buildForm(InputfieldForm $form)
InputfieldForm
ProcessPageEdit::buildFormChildren()
InputfieldWrapper
ProcessPageEdit::buildFormContent()
InputfieldWrapper
ProcessPageEdit::buildFormDelete()
InputfieldWrapper
ProcessPageEdit::buildFormRoles()
InputfieldMarkup
ProcessPageEdit::buildFormSettings()
InputfieldWrapper
ProcessPageEdit::buildFormSortfield(string $sortfield, Process $caller)
InputfieldFieldsetBuild the sortfield configuration fieldset 
ProcessPageEdit::buildFormView($url)
(nothing)
ProcessPageEdit::deletedPage($page, $redirectUrl)
(nothing)
ProcessPageEdit::execute()
stringExecute the Page Edit process by building the form and checking if it was submitted
ProcessPageEdit::executeBookmarks()
stringBookmarks action
ProcessPageEdit::executeNavJSON()
stringnavJSON action
ProcessPageEdit::executeSaveTemplate()
(nothing)Save a template change for a page (handler for /saveTemplate/ action)
ProcessPageEdit::executeTemplate()
stringExecute a template change for a page, building an info + confirmation form (handler for /template/ action)
ProcessPageEdit::getAfterLoginUrl(Page $page)
stringURL to redirect to after non-authenticated user is logged-in, or false if module does not support 
ProcessPageEdit::getAllowedStatuses()
arrayGet allowed page statuses 
ProcessPageEdit::getEditUrl()
stringGet URL (or form action attribute) for editing this page 
ProcessPageEdit::getMasterPage()
null PageGet the 'master' page (if set) 
ProcessPageEdit::getPage()
PageReturn instance of the Page being edited (required by WirePageEditor interface) 
ProcessPageEdit::getRedirectUrl()
stringGet the current redirectUrl 
ProcessPageEdit::getTabs()
arrayReturns associative array of tab ID => tab Label
ProcessPageEdit::getViewUrl()
stringGet URL to view this page 
ProcessPageEdit::isAllowedTemplate($id)
boolIs the given template or template ID allowed here? 
ProcessPageEdit::isSubmit()
boolAre we processing a submitted page edit form in this request? 
ProcessPageEdit::loadPage($id)
Page
ProcessPageEdit::noticeIncomplete string 
ProcessPageEdit::noticeLocked string 
ProcessPageEdit::noticeNoAccess string 
ProcessPageEdit::noticeUnknown string 
ProcessPageEdit::processInput(InputfieldWrapper $form)
(nothing)
ProcessPageEdit::processInputErrorAction(Page $page, $inputfield, string $name)
boolProcess required error actions as configured with page’s template 
ProcessPageEdit::processSaveRedirect($redirectUrl)
(nothing)
ProcessPageEdit::removeTab(string $id)
(nothing)Remove the tab with the given id 
ProcessPageEdit::setEditor(WirePageEditor $editor)
(nothing)Set the primary editor, if not ProcessPageEdit 
ProcessPageEdit::setMasterPage(Page $page)
(nothing)Set the 'master' page 
ProcessPageEdit::setPage(Page $page)
(nothing)Set the page being edited 
ProcessPageEdit::setPredefinedParents(PageArray $parents)
(nothing)Set predefined allowed parents 
ProcessPageEdit::setPredefinedTemplates($templates)
(nothing)Set predefined allowed templates 
ProcessPageEdit::setRedirectUrl(string $url)
(nothing)Called on save requests, sets the next redirect URL for the next request 
ProcessPageEdit::setUseSettings(bool $useSettings)
(nothing)Set whether or not 'settings' tab should show 
ProcessPageEdit::setupBreadcrumbs()
(nothing)Setup the breadcrumbs used in the UI 
ProcessPageEdit::setupHeadline()
(nothing)Set the headline used in the UI 
ProcessPageEdit::useBookmarks bool 
ProcessPageEdit::viewAction string One of 'panel', 'modal', 'new', 'this' (see getViewActions method) 
ProcessPageEdit::wired()
(nothing)Wired to API 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #548
    In the 548th issue of ProcessWire Weekly we're going to check out a couple of new third party modules, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 9 November 2024
  • 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

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer