InputfieldPage class

Select one or more pages

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

Common
For hooks

Common

Name	Return	Summary
InputfieldPage::addClass() InputfieldPage::addClass($class) InputfieldPage::addClass($class, string $property = 'class')	`InputfieldPage` `Inputfield`	Add a CSS class name (extends Inputfield::addClass)
InputfieldPage::addable	`int` `bool`
InputfieldPage::allowUnpub	`int` `bool`
InputfieldPage::createFindPagesSelector() InputfieldPage::createFindPagesSelector() InputfieldPage::createFindPagesSelector(array $options = [])	`string` `array`	Create a page finding selector from all configured properties
InputfieldPage::derefAsPage	`int`
InputfieldPage::findPagesCode() InputfieldPage::findPagesCode(Page $page) InputfieldPage::findPagesCode(Page $page)	`PageArray`	Can also be used as property: InputfieldPage::findPagesCode
InputfieldPage::findPagesSelect	`string`	Same as findPageSelector, but configured interactively with InputfieldSelector .
InputfieldPage::findPagesSelector	`string`
InputfieldPage::getConfigInputfields() InputfieldPage::getConfigInputfields() InputfieldPage::getConfigInputfields()	`InputfieldWrapper`	Get field configuration Inputfields
InputfieldPage::getFieldSetups() InputfieldPage::getFieldSetups() InputfieldPage::getFieldSetups()	`array`	Get recommended setups for FieldtypePage/InputfieldPage
InputfieldPage::getInputfield() InputfieldPage::getInputfield() InputfieldPage::getInputfield()	`Inputfield` `null`	Get delegate Inputfield for page selection
InputfieldPage::getInputfieldOptions() InputfieldPage::getInputfieldOptions() InputfieldPage::getInputfieldOptions()	`array`	Get options available for page selection Inputfields
InputfieldPage::getPageLabel() InputfieldPage::getPageLabel(Page $page) InputfieldPage::getPageLabel(Page $page, bool $allowMarkup = false)	`string`	Get a label for the given page
InputfieldPage::getSelectablePages() InputfieldPage::getSelectablePages(Page $page) InputfieldPage::getSelectablePages(Page $page)	`PageArray` `null`	Return PageArray of selectable pages for this input
InputfieldPage::getSetting() InputfieldPage::getSetting($key) InputfieldPage::getSetting($key)	`mixed`	Gets a setting (or API variable) from the Inputfield, while ignoring attributes.
InputfieldPage::getTemplateIDs() InputfieldPage::getTemplateIDs() InputfieldPage::getTemplateIDs(bool $getString = false)	`array` `string`	Return array or string of configured template IDs
InputfieldPage::has() InputfieldPage::has($key) InputfieldPage::has($key)	`bool`	Does this Inputfield have the requested property or attribute?
InputfieldPage::inputfield	`string`	Inputfield class used for input
InputfieldPage::inputfieldClass	`string`	Public property alias of protected getInputfieldClass() method
InputfieldPage::inputfieldClasses	`array`
InputfieldPage::isEmpty() InputfieldPage::isEmpty() InputfieldPage::isEmpty()	`bool`	Does this Inputfield have an empty value?
InputfieldPage::isValidPage() InputfieldPage::isValidPage(Page $page, $field) InputfieldPage::isValidPage(Page $page, $field, Page $editPage = null)	`bool`	Is the given $page valid for the given $field?
InputfieldPage::labelFieldFormat	`string`	Formatting string for $page->getMarkup() as alternative to $labelFieldName
InputfieldPage::labelFieldName	`string`	Field name to use for label (note: this will be "." if $labelFieldFormat is in use).
InputfieldPage::parent_id	`int`
InputfieldPage::processInput() InputfieldPage::processInput(WireInputData $input) InputfieldPage::processInput(WireInputData $input)	`this` `Inputfield`	Process input
InputfieldPage::processInputAddPages() InputfieldPage::processInputAddPages(WireInputData $input) InputfieldPage::processInputAddPages(WireInputData $input)	(nothing)
InputfieldPage::render() InputfieldPage::render() InputfieldPage::render()	`string`	Render
InputfieldPage::renderAddable() InputfieldPage::renderAddable() InputfieldPage::renderAddable()	`string`
InputfieldPage::renderReady() InputfieldPage::renderReady() InputfieldPage::renderReady(Inputfield $parent = null, bool $renderValueMode = false)	`bool`	Called before render()
InputfieldPage::renderValue() InputfieldPage::renderValue() InputfieldPage::renderValue()	`string`	Render non-editable value
InputfieldPage::setAttribute() InputfieldPage::setAttribute($key, $value) InputfieldPage::setAttribute($key, $value)	`InputfieldPage` `Inputfield`	Set an input attribute
InputfieldPage::template_id	`int`
InputfieldPage::template_ids	`array`

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
InputfieldPage::renderPageLabel() InputfieldPage::renderPageLabel(Page $page) InputfieldPage::renderPageLabel(Page $page, bool $allowMarkup = false)	`string`	Render a label for the given page

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Select one or more pages

Common

For hooks

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news