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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK