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)
string

Get label to represent given $page

 
InputfieldPageListSelectMultiple::pageListReady(string $name, string $labelFieldName)
None

Render ready

 
InputfieldPageListSelectMultiple::processInput(WireInputData $input)
$this

Convert the CSV string provide in the $input to an array of ints needed for this fieldtype

InputfieldPageListSelectMultiple::render()
None
InputfieldPageListSelectMultiple::renderMarkupValue($value)
string

Render markup value for PageListSelect/PageListSelectMultiple

 
InputfieldPageListSelectMultiple::renderParentError()
string

Render an error message that a parent ID is missing in field settings

 
InputfieldPageListSelectMultiple::renderReady()
None 
InputfieldPageListSelectMultiple::renderValue()
None

Properties

NameReturnSummary 
InputfieldPageListSelectMultiple::cancelLabel string Label text to click to cancel selection
DEFAULT: Close
 
InputfieldPageListSelectMultiple::labelFieldName string Name of field to use for page labels
DEFAULT: title
 
InputfieldPageListSelectMultiple::moreLabel string Label text to click for revealing more selectable pages
DEFAULT: more
 
InputfieldPageListSelectMultiple::parent_id int Parent ID of selectable pages
DEFAULT: 0
 
InputfieldPageListSelectMultiple::removeLabel string Label text to click for removing a selected page
DEFAULT: Remove
 
InputfieldPageListSelectMultiple::selectLabel string Label text to click to make selection
DEFAULT: Select
 
InputfieldPageListSelectMultiple::selectedLabel string Label text to indicate a selected page
DEFAULT: Selected
 
InputfieldPageListSelectMultiple::startLabel string Label text to click to start selection
DEFAULT: Add
 
InputfieldPageListSelectMultiple::unselectLabel string Label text to click to undo selection
DEFAULT: 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.252