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.

Show class?             Show args?        

Common

NameReturnSummary 
InputfieldPage::addClass($class)
InputfieldPage InputfieldAdd a CSS class name (extends Inputfield::addClass) 
InputfieldPage::addable int bool 
InputfieldPage::allowUnpub int bool 
InputfieldPage::createFindPagesSelector()
string arrayCreate a page finding selector from all configured properties 
InputfieldPage::derefAsPage int 
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()
InputfieldWrapperGet field configuration Inputfields
InputfieldPage::getFieldSetups()
arrayGet recommended setups for FieldtypePage/InputfieldPage 
InputfieldPage::getInputfield()
Inputfield nullGet delegate Inputfield for page selection 
InputfieldPage::getInputfieldOptions()
arrayGet options available for page selection Inputfields 
InputfieldPage::getPageLabel(Page $page)
stringGet a label for the given page 
InputfieldPage::getSelectablePages(Page $page)
PageArray nullReturn PageArray of selectable pages for this input
InputfieldPage::getSetting($key)
mixedGets a setting (or API variable) from the Inputfield, while ignoring attributes. 
InputfieldPage::getTemplateIDs()
array stringReturn array or string of configured template IDs 
InputfieldPage::has($key)
boolDoes 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()
boolDoes this Inputfield have an empty value? 
InputfieldPage::isValidPage(Page $page, $field)
boolIs 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(WireInputData $input)
this InputfieldProcess input
InputfieldPage::processInputAddPages(WireInputData $input)
(nothing)
InputfieldPage::render()
stringRender
InputfieldPage::renderAddable()
string
InputfieldPage::renderReady()
boolCalled before render() 
InputfieldPage::renderValue()
stringRender non-editable value
InputfieldPage::setAttribute($key, $value)
InputfieldPage InputfieldSet 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.

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

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer