InputfieldPageListSelect class

A Page List Selector for selecting a single 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 InputfieldPageListSelect class also inherits all the methods and properties of: Inputfield, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
InputfieldPageListSelect::getPageLabel() InputfieldPageListSelect::getPageLabel(Page $page) InputfieldPageListSelect::getPageLabel(Page $page)	`string`	Get label to represent given $page
InputfieldPageListSelect::isEmpty() InputfieldPageListSelect::isEmpty() InputfieldPageListSelect::isEmpty()	None
InputfieldPageListSelect::pageListReady() InputfieldPageListSelect::pageListReady(string $name, string $labelFieldName) InputfieldPageListSelect::pageListReady(string $name, string $labelFieldName)	None	Render ready
InputfieldPageListSelect::processInput() InputfieldPageListSelect::processInput($input) InputfieldPageListSelect::processInput($input)	None
InputfieldPageListSelect::render() InputfieldPageListSelect::render() InputfieldPageListSelect::render()	None
InputfieldPageListSelect::renderMarkupValue() InputfieldPageListSelect::renderMarkupValue($value) InputfieldPageListSelect::renderMarkupValue($value)	`string`	Render markup value for PageListSelect/PageListSelectMultiple
InputfieldPageListSelect::renderParentError() InputfieldPageListSelect::renderParentError() InputfieldPageListSelect::renderParentError()	`string`	Render an error message that a parent ID is missing in field settings
InputfieldPageListSelect::renderReady() InputfieldPageListSelect::renderReady() InputfieldPageListSelect::renderReady($parent = null, $renderValueMode = false)	None
InputfieldPageListSelect::renderValue() InputfieldPageListSelect::renderValue() InputfieldPageListSelect::renderValue()	None
InputfieldPageListSelect::setAttribute() InputfieldPageListSelect::setAttribute($key, $value) InputfieldPageListSelect::setAttribute($key, $value)	None

Properties

Name	Return	Summary
InputfieldPageListSelect::cancelLabel	`string`	Label text to click to cancel selection DEFAULT: Cancel
InputfieldPageListSelect::labelFieldName	`string`	Name of field to use for page labels DEFAULT: title
InputfieldPageListSelect::moreLabel	`string`	Label text to click for revealing more selectable pages DEFAULT: more
InputfieldPageListSelect::parent_id	`int`	Parent ID of selectable pages DEFAULT: 0
InputfieldPageListSelect::selectLabel	`string`	Label text to click to make selection DEFAULT: Select
InputfieldPageListSelect::showPath	`bool`	Show path of selectable pages? DEFAULT: fales
InputfieldPageListSelect::startLabel	`string`	Label text to click to start selection DEFAULT: Change
InputfieldPageListSelect::unselectLabel	`string`	Label text to click to undo selection DEFAULT: Unselect

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.252