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.

Common

Name	Return	Summary
ProcessPageEdit::addTab() ProcessPageEdit::addTab(string $id, string $label) ProcessPageEdit::addTab(string $id, string $label, $wrapper = null)	None	Add a tab with HTML id attribute and label
ProcessPageEdit::buildFormSortfield() ProcessPageEdit::buildFormSortfield(string $sortfield, Process $caller) ProcessPageEdit::buildFormSortfield(string $sortfield, Process $caller)	`InputfieldFieldset`	Build the sortfield configuration fieldset
ProcessPageEdit::execute() ProcessPageEdit::execute() ProcessPageEdit::execute()	`string`	Execute the Page Edit process by building the form and checking if it was submitted
ProcessPageEdit::executeBookmarks() ProcessPageEdit::executeBookmarks() ProcessPageEdit::executeBookmarks()	`string`	Bookmarks action
ProcessPageEdit::executeNavJSON() ProcessPageEdit::executeNavJSON() ProcessPageEdit::executeNavJSON(array $options = [])	`string`	navJSON action
ProcessPageEdit::executeSaveTemplate() ProcessPageEdit::executeSaveTemplate() ProcessPageEdit::executeSaveTemplate()	None	Save a template change for a page (handler for /saveTemplate/ action)
ProcessPageEdit::executeTemplate() ProcessPageEdit::executeTemplate() ProcessPageEdit::executeTemplate()	`string`	Execute a template change for a page, building an info + confirmation form (handler for /template/ action)
ProcessPageEdit::getAfterLoginUrl() ProcessPageEdit::getAfterLoginUrl(Page $page) 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() ProcessPageEdit::getAllowedStatuses() ProcessPageEdit::getAllowedStatuses()	`array`	Get allowed page statuses
ProcessPageEdit::getEditUrl() ProcessPageEdit::getEditUrl() ProcessPageEdit::getEditUrl(array $options = [])	`string`	Get URL (or form action attribute) for editing this page
ProcessPageEdit::getMasterPage() ProcessPageEdit::getMasterPage() ProcessPageEdit::getMasterPage()	`null` `Page`	Get the 'master' page (if set)
ProcessPageEdit::getPage() ProcessPageEdit::getPage() ProcessPageEdit::getPage()	`Page`	Return instance of the Page being edited (required by WirePageEditor interface)
ProcessPageEdit::getRedirectUrl() ProcessPageEdit::getRedirectUrl() ProcessPageEdit::getRedirectUrl(array $extras = [])	`string`	Get the current redirectUrl
ProcessPageEdit::getTabs() ProcessPageEdit::getTabs() ProcessPageEdit::getTabs()	`array`	Returns associative array of tab ID => tab Label
ProcessPageEdit::getViewUrl() ProcessPageEdit::getViewUrl() ProcessPageEdit::getViewUrl($language = null)	`string`	Get URL to view this page
ProcessPageEdit::isAllowedTemplate() ProcessPageEdit::isAllowedTemplate($id) ProcessPageEdit::isAllowedTemplate($id)	`bool`	Is the given template or template ID allowed here?
ProcessPageEdit::isSubmit() ProcessPageEdit::isSubmit() ProcessPageEdit::isSubmit()	`bool`	Are we processing a submitted page edit form in this request?
ProcessPageEdit::processInputErrorAction() ProcessPageEdit::processInputErrorAction(Page $page, $inputfield, string $name) ProcessPageEdit::processInputErrorAction(Page $page, $inputfield, string $name, $errorAction = null)	`bool`	Process required error actions as configured with page’s template
ProcessPageEdit::removeTab() ProcessPageEdit::removeTab(string $id) ProcessPageEdit::removeTab(string $id)	None	Remove the tab with the given id
ProcessPageEdit::setEditor() ProcessPageEdit::setEditor(WirePageEditor $editor) ProcessPageEdit::setEditor(WirePageEditor $editor)	None	Set the primary editor, if not ProcessPageEdit
ProcessPageEdit::setMasterPage() ProcessPageEdit::setMasterPage(Page $page) ProcessPageEdit::setMasterPage(Page $page)	None	Set the 'master' page
ProcessPageEdit::setPage() ProcessPageEdit::setPage(Page $page) ProcessPageEdit::setPage(Page $page)	None	Set the page being edited
ProcessPageEdit::setPredefinedParents() ProcessPageEdit::setPredefinedParents(PageArray $parents) ProcessPageEdit::setPredefinedParents(PageArray $parents)	None	Set predefined allowed parents
ProcessPageEdit::setPredefinedTemplates() ProcessPageEdit::setPredefinedTemplates($templates) ProcessPageEdit::setPredefinedTemplates($templates)	None	Set predefined allowed templates
ProcessPageEdit::setRedirectUrl() ProcessPageEdit::setRedirectUrl(string $url) ProcessPageEdit::setRedirectUrl(string $url)	None	Called on save requests, sets the next redirect URL for the next request
ProcessPageEdit::setUseSettings() ProcessPageEdit::setUseSettings(bool $useSettings) ProcessPageEdit::setUseSettings(bool $useSettings)	None	Set whether or not 'settings' tab should show
ProcessPageEdit::setupBreadcrumbs() ProcessPageEdit::setupBreadcrumbs() ProcessPageEdit::setupBreadcrumbs()	None	Setup the breadcrumbs used in the UI
ProcessPageEdit::setupHeadline() ProcessPageEdit::setupHeadline() ProcessPageEdit::setupHeadline()	None	Set the headline used in the UI
ProcessPageEdit::wired() ProcessPageEdit::wired() ProcessPageEdit::wired()	None	Wired to API

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
ProcessPageEdit::ajaxSaveDone() ProcessPageEdit::ajaxSaveDone(Page $page, array $data) ProcessPageEdit::ajaxSaveDone(Page $page, array $data)	`bool`	Ajax save done - send output
ProcessPageEdit::buildFormCreatedUser() ProcessPageEdit::buildFormCreatedUser() ProcessPageEdit::buildFormCreatedUser()	`Inputfield`	Build the created user selection
ProcessPageEdit::getSubmitActions() ProcessPageEdit::getSubmitActions() ProcessPageEdit::getSubmitActions()	`array`	Get actions for submit button(s)
ProcessPageEdit::getViewActions() ProcessPageEdit::getViewActions() ProcessPageEdit::getViewActions(array $actions = [], bool $configMode = false)	`array`	Get actions for the "View" dropdown
ProcessPageEdit::processSubmitAction() ProcessPageEdit::processSubmitAction(string $value) ProcessPageEdit::processSubmitAction(string $value)	`bool`	Process the given submit action value

Properties

Name	Return	Summary
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.251