ProcessPageEdit class

Provides the UI for editing a page

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 ProcessPageEdit class also inherits all the methods and properties of: Process, WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ProcessPageEdit::addTab(string $id, string $label)
None

Add a tab with HTML id attribute and label

 
ProcessPageEdit::buildFormSortfield(string $sortfield, Process $caller)
InputfieldFieldset

Build the sortfield configuration fieldset

 
ProcessPageEdit::execute()
string

Execute the Page Edit process by building the form and checking if it was submitted

ProcessPageEdit::executeBookmarks()
string

Bookmarks action

ProcessPageEdit::executeNavJSON()
string

navJSON action

ProcessPageEdit::executeSaveTemplate()
None

Save a template change for a page (handler for /saveTemplate/ action)

ProcessPageEdit::executeTemplate()
string

Execute a template change for a page, building an info + confirmation form (handler for /template/ action)

ProcessPageEdit::getAfterLoginUrl(Page $page)
string

URL to redirect to after non-authenticated user is logged-in, or false if module does not support

 
ProcessPageEdit::getAllowedStatuses()
array

Get allowed page statuses

 
ProcessPageEdit::getEditUrl()
string

Get URL (or form action attribute) for editing this page

 
ProcessPageEdit::getMasterPage()
null Page

Get the 'master' page (if set)

 
ProcessPageEdit::getPage()
Page

Return instance of the Page being edited (required by WirePageEditor interface)

 
ProcessPageEdit::getRedirectUrl()
string

Get the current redirectUrl

 
ProcessPageEdit::getTabs()
array

Returns associative array of tab ID => tab Label

ProcessPageEdit::getViewUrl()
string

Get URL to view this page

 
ProcessPageEdit::isAllowedTemplate($id)
bool

Is the given template or template ID allowed here?

 
ProcessPageEdit::isSubmit()
bool

Are we processing a submitted page edit form in this request?

 
ProcessPageEdit::processInputErrorAction(Page $page, $inputfield, string $name)
bool

Process required error actions as configured with page’s template

 
ProcessPageEdit::removeTab(string $id)
None

Remove the tab with the given id

 
ProcessPageEdit::setEditor(WirePageEditor $editor)
None

Set the primary editor, if not ProcessPageEdit

 
ProcessPageEdit::setMasterPage(Page $page)
None

Set the 'master' page

 
ProcessPageEdit::setPage(Page $page)
None

Set the page being edited

 
ProcessPageEdit::setPredefinedParents(PageArray $parents)
None

Set predefined allowed parents

 
ProcessPageEdit::setPredefinedTemplates($templates)
None

Set predefined allowed templates

 
ProcessPageEdit::setRedirectUrl(string $url)
None

Called on save requests, sets the next redirect URL for the next request

 
ProcessPageEdit::setUseSettings(bool $useSettings)
None

Set whether or not 'settings' tab should show

 
ProcessPageEdit::setupBreadcrumbs()
None

Setup the breadcrumbs used in the UI

 
ProcessPageEdit::setupHeadline()
None

Set the headline used in the UI

 
ProcessPageEdit::wired()
None

Wired to API

 

Properties

NameReturnSummary 
ProcessPageEdit::noticeIncomplete string 
ProcessPageEdit::noticeLocked string 
ProcessPageEdit::noticeNoAccess string 
ProcessPageEdit::noticeUnknown string 
ProcessPageEdit::useBookmarks bool 
ProcessPageEdit::viewAction string One of 'panel', 'modal', 'new', 'this' (see getViewActions method) 

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.253