ProcessPageAdd class

Provides the UI for adding 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 ProcessPageAdd class also inherits all the methods and properties of: Process, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
ProcessPageAdd::clearSessionCaches() ProcessPageAdd::clearSessionCaches() ProcessPageAdd::clearSessionCaches()	None	Clear "add new" session caches
ProcessPageAdd::execute() ProcessPageAdd::execute() ProcessPageAdd::execute()	`string`	Main execution, first screen of adding a Page
ProcessPageAdd::executeBookmarks() ProcessPageAdd::executeBookmarks() ProcessPageAdd::executeBookmarks()	`string`	Execute the Page Bookmarks
ProcessPageAdd::executeExists() ProcessPageAdd::executeExists() ProcessPageAdd::executeExists()	`string`	Method to handle AJAX call to check of a given page name exists for a parent
ProcessPageAdd::executeNavJSON() ProcessPageAdd::executeNavJSON() ProcessPageAdd::executeNavJSON(array $options = [])	`array` `string`	Return list of addable templates and links to add them
ProcessPageAdd::executeTemplate() ProcessPageAdd::executeTemplate() ProcessPageAdd::executeTemplate()	`string`	Ask user to select template and parent
ProcessPageAdd::getPage() ProcessPageAdd::getPage() ProcessPageAdd::getPage()	`Page` `null`	Get the Page that is being edited
ProcessPageAdd::getShortcutSortField() ProcessPageAdd::getShortcutSortField() ProcessPageAdd::getShortcutSortField()	`InputfieldAsmSelect` `InputfieldHidden`	Get Inputfield that lets you define shorcuts and sort order
ProcessPageAdd::renderChooseTemplate() ProcessPageAdd::renderChooseTemplate() ProcessPageAdd::renderChooseTemplate()	`string`	Render an HTML definition list template selection for when no parent/template is known
ProcessPageAdd::set() ProcessPageAdd::set(string $key, mixed $value) ProcessPageAdd::set(string $key, mixed $value)	`Process` `ProcessPageAdd`	Set property
ProcessPageAdd::setEditor() ProcessPageAdd::setEditor(WirePageEditor $editor) ProcessPageAdd::setEditor(WirePageEditor $editor)	None	Set the WirePageEditor that is calling this Process
ProcessPageAdd::setPredefinedParents() ProcessPageAdd::setPredefinedParents(PageArray $parents) ProcessPageAdd::setPredefinedParents(PageArray $parents)	None	Predefine the allowed parents, separately from family/auto-detect
ProcessPageAdd::setPredefinedTemplates() ProcessPageAdd::setPredefinedTemplates($templates) ProcessPageAdd::setPredefinedTemplates($templates)	None	Predefine the allowed templates, separately from family/auto-detect
ProcessPageAdd::setupBreadcrumbs() ProcessPageAdd::setupBreadcrumbs() ProcessPageAdd::setupBreadcrumbs()	None	Setup the UI breadcrumb trail

Properties

Name	Return	Summary
ProcessPageAdd::noAutoPublish	`bool` `int`	Disable automatic publishing?
ProcessPageAdd::parent_id	`int`
ProcessPageAdd::template	`Template`

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251