InputfieldPageListSelectMultiple class

A multi-selection Inputfield for selecting multiple pages from a page tree.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldPageListSelectMultiple class also inherits all the methods and properties of: Inputfield, WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
InputfieldPageListSelectMultiple::getPageLabel(Page $page)
stringGet label to represent given $page 
InputfieldPageListSelectMultiple::pageListReady(string $name, string $labelFieldName)
NoneRender ready 
InputfieldPageListSelectMultiple::processInput(WireInputData $input)
$thisConvert the CSV string provide in the $input to an array of ints needed for this fieldtype
InputfieldPageListSelectMultiple::render()
None
InputfieldPageListSelectMultiple::renderMarkupValue($value)
stringRender markup value for PageListSelect/PageListSelectMultiple 
InputfieldPageListSelectMultiple::renderParentError()
stringRender an error message that a parent ID is missing in field settings 
InputfieldPageListSelectMultiple::renderReady()
None 
InputfieldPageListSelectMultiple::renderValue()
None

Properties

NameReturnSummaryDefault
InputfieldPageListSelectMultiple::cancelLabel string Label text to click to cancel selection Close
InputfieldPageListSelectMultiple::labelFieldName string Name of field to use for page labels title
InputfieldPageListSelectMultiple::moreLabel string Label text to click for revealing more selectable pages more
InputfieldPageListSelectMultiple::parent_id int Parent ID of selectable pages 0
InputfieldPageListSelectMultiple::removeLabel string Label text to click for removing a selected page Remove
InputfieldPageListSelectMultiple::selectLabel string Label text to click to make selection Select
InputfieldPageListSelectMultiple::selectedLabel string Label text to indicate a selected page Selected
InputfieldPageListSelectMultiple::startLabel string Label text to click to start selection Add
InputfieldPageListSelectMultiple::unselectLabel string Label text to click to undo selection Unselect

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251