InputfieldWrapper class

A type of Inputfield that contains other Inputfield objects as children. Commonly a form or a fieldset.

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

Show class?             Show args?        

Common

NameReturnSummary 
InputfieldWrapper::InputfieldAsmSelect InputfieldAsmSelect 
InputfieldWrapper::InputfieldButton InputfieldButton 
InputfieldWrapper::InputfieldCheckbox InputfieldCheckbox 
InputfieldWrapper::InputfieldCheckboxes InputfieldCheckboxes 
InputfieldWrapper::InputfieldCkeditor InputfieldCKEditor 
InputfieldWrapper::InputfieldCommentsAdmin InputfieldCommentsAdmin 
InputfieldWrapper::InputfieldDatetime InputfieldDatetime 
InputfieldWrapper::InputfieldEmail InputfieldEmail 
InputfieldWrapper::InputfieldFieldset InputfieldFieldset 
InputfieldWrapper::InputfieldFieldsetOpen InputfieldFieldsetOpen 
InputfieldWrapper::InputfieldFieldsetTabOpen InputfieldFieldsetTabOpen 
InputfieldWrapper::InputfieldFile InputfieldFile 
InputfieldWrapper::InputfieldFloat InputfieldFloat 
InputfieldWrapper::InputfieldForm InputfieldForm 
InputfieldWrapper::InputfieldHidden InputfieldHidden 
InputfieldWrapper::InputfieldIcon InputfieldIcon 
InputfieldWrapper::InputfieldImage InputfieldImage 
InputfieldWrapper::InputfieldInteger InputfieldInteger 
InputfieldWrapper::InputfieldMarkup InputfieldMarkup 
InputfieldWrapper::InputfieldName InputfieldName 
InputfieldWrapper::InputfieldPage InputfieldPage 
InputfieldWrapper::InputfieldPageAutocomplete InputfieldPageAutocomplete 
InputfieldWrapper::InputfieldPageListSelect InputfieldPageListSelect 
InputfieldWrapper::InputfieldPageListSelectMultiple InputfieldPageListSelectMultiple 
InputfieldWrapper::InputfieldPageName InputfieldPageName 
InputfieldWrapper::InputfieldPageTable InputfieldPageTable 
InputfieldWrapper::InputfieldPageTitle InputfieldPageTitle 
InputfieldWrapper::InputfieldPassword InputfieldPassword 
InputfieldWrapper::InputfieldRadios InputfieldRadios 
InputfieldWrapper::InputfieldRepeater InputfieldRepeater 
InputfieldWrapper::InputfieldSelect InputfieldSelect 
InputfieldWrapper::InputfieldSelectMultiple InputfieldSelectMultiple 
InputfieldWrapper::InputfieldSelector InputfieldSelector 
InputfieldWrapper::InputfieldSubmit InputfieldSubmit 
InputfieldWrapper::InputfieldText InputfieldText 
InputfieldWrapper::InputfieldTextTags InputfieldTextTags 
InputfieldWrapper::InputfieldTextarea InputfieldTextarea 
InputfieldWrapper::InputfieldToggle InputfieldToggle 
InputfieldWrapper::InputfieldURL InputfieldURL 
InputfieldWrapper::InputfieldWrapper InputfieldWrapper 
InputfieldWrapper::InputfieldlFieldsetClose InputfieldFieldsetClose 
InputfieldWrapper::getValueByName(string $name)
string int float bool array object nullGet value of Inputfield by name 
InputfieldWrapper::wired()
(nothing) 

Manipulation

NameReturnSummary 
InputfieldWrapper::add($item)
Inputfield InputfieldWrapper thisAdd an Inputfield item as a child (also accepts array definition) 
InputfieldWrapper::append(Inputfield $item)
$thisAppend an Inputfield to this instance’s children. 
InputfieldWrapper::import($items)
$thisImport the given Inputfield items as children 
InputfieldWrapper::importArray(array $a)
$thisImport an array of Inputfield definitions to to this InputfieldWrapper instance 
InputfieldWrapper::insertAfter(Inputfield $item, Inputfield $existingItem)
$thisInsert one Inputfield after one that’s already there. 
InputfieldWrapper::insertBefore(Inputfield $item, Inputfield $existingItem)
$thisInsert one Inputfield before one that’s already there. 
InputfieldWrapper::new(string $typeName)
Inputfield InputfieldSelect InputfieldWrapperCreate a new Inputfield, add it to this InputfieldWrapper, and return the new Inputfield
InputfieldWrapper::populateValues($data)
arrayPopulate values for all Inputfields in this wrapper from the given $data object or array. 
InputfieldWrapper::prepend(Inputfield $item)
$thisPrepend an Inputfield to this instance’s children. 
InputfieldWrapper::remove($item)
$thisRemove an Inputfield from this instance’s children. 

Retrieval and traversal

NameReturnSummary 
InputfieldWrapper::child()
Inputfield nullFind an Inputfield below this one that has the given name 
InputfieldWrapper::children()
InputfieldsArrayReturn all children Inputfield objects
Can also be used as property: InputfieldWrapper::children
 
InputfieldWrapper::count()
intReturn the quantity of children present 
InputfieldWrapper::find(string $selector)
InputfieldsArrayFind all children Inputfields matching a selector string 
InputfieldWrapper::get(string $key)
Inputfield mixedGet a child Inputfield having a name attribute matching the given $key. 
InputfieldWrapper::getAll()
InputfieldWrapperGet all Inputfields below this recursively in a flat InputfieldWrapper (children, and their children, etc.) 
InputfieldWrapper::getByName(string $name)
Inputfield nullShorter alias of getChildByName() 
InputfieldWrapper::getChildByName(string $name)
Inputfield nullGiven an Inputfield name, return the child Inputfield or NULL if not found. 
InputfieldWrapper::getErrors()
arrayReturn an array of errors that occurred on any of the children during input processing. 
InputfieldWrapper::getIterator()
InputfieldsArrayEnables foreach() of the children of this class 
InputfieldWrapper::isEmpty()
boolReturns true if all children are empty, or false if one or more is populated 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK