ProcessPageList class

Generates the ajax/js hierarchical page lists used throughout ProcessWire

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

Common
Properties

Common

Name	Return	Summary
ProcessPageList::ajaxAction() ProcessPageList::ajaxAction(string $action) ProcessPageList::ajaxAction(string $action)	`string`	Process an AJAX action and return JSON string
ProcessPageList::execute() ProcessPageList::execute() ProcessPageList::execute()	`string`	Execute the Page List
ProcessPageList::executeBookmarks() ProcessPageList::executeBookmarks() ProcessPageList::executeBookmarks()	`string`	Execute the Page Bookmarks (to be phased out)
ProcessPageList::executeId() ProcessPageList::executeId() ProcessPageList::executeId()	None
ProcessPageList::executeNavJSON() ProcessPageList::executeNavJSON() ProcessPageList::executeNavJSON(array $options = [])	`string` `array`	Output JSON list of navigation items for this module's bookmarks
ProcessPageList::executeOpen() ProcessPageList::executeOpen() ProcessPageList::executeOpen()	None
ProcessPageList::find() ProcessPageList::find(string $selectorString, Page $page) ProcessPageList::find(string $selectorString, Page $page)	`PageArray`	@param string $selectorString
ProcessPageList::getAfterLoginUrl() ProcessPageList::getAfterLoginUrl(Page $page) ProcessPageList::getAfterLoginUrl(Page $page)	`string`	URL to redirect to after non-authenticated user is logged-in, or false if module does not support
ProcessPageList::getPage() ProcessPageList::getPage() ProcessPageList::getPage()	`Page` `null`	Get parent page that current request is for
ProcessPageList::getSelector() ProcessPageList::getSelector(Page $page, array $options) ProcessPageList::getSelector(Page $page, array $options)	`string`	Get selector string to use in finding children
ProcessPageList::renderReady() ProcessPageList::renderReady() ProcessPageList::renderReady()	None	Setup for render
ProcessPageList::set() ProcessPageList::set(string $key, mixed $value) ProcessPageList::set(string $key, mixed $value)	`Process` `ProcessPageList`	Set a value to this Page List (see WireData)
ProcessPageList::setPageLabelField() ProcessPageList::setPageLabelField($name, $pageLabelField) ProcessPageList::setPageLabelField($name, $pageLabelField)	None	Set the page label field
ProcessPageList::setupBreadcrumbs() ProcessPageList::setupBreadcrumbs() ProcessPageList::setupBreadcrumbs()	None	Setup the Breadcrumbs for the UI

Properties

Name	Return	Summary
ProcessPageList::hidePages	`array`	Page IDs to hide from root page list. 3.0.202+
ProcessPageList::hidePagesNot	`array`	Values of 'debug', 'advanced', 'superuser' to not hide above pages when in that state. 3.0.202+
ProcessPageList::hoverActionDelay	`int`	Milliseconds delay between hover and showing of actions.
ProcessPageList::hoverActionFade	`int`	Milliseconds to spend fading in or out actions.
ProcessPageList::limit	`int`	Items to show per pagination.
ProcessPageList::pageLabelField	`string`	Field name or field names (space separated) that should be used for page label.
ProcessPageList::qtyType	`string`	What to show in children quantity label? 'children', 'total', 'children/total', 'total/children', or 'id'
ProcessPageList::showRootPage	`bool`	Whether root page (like home) should be shown.
ProcessPageList::speed	`int`	Animation speed (in ms)
ProcessPageList::useBookmarks	`bool` `int`	Allow use of PageList bookmarks?
ProcessPageList::useHoverActions	`bool` `int`	Whether or not to use hover mode for action links.
ProcessPageList::useTrash	`bool` `int`	Allow non-superusers to use Trash?

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251