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.

Manipulation / Retrieval and traversal / Output / Input / Module

Manipulation

Name Return Summary  
InputfieldWrapper::add($item) $this Add an Inputfield item as a child (also accepts array definition)
InputfieldWrapper::append(Inputfield $item) $this Append an Inputfield to this instance’s children.
InputfieldWrapper::import($items) $this Import the given Inputfield items as children
InputfieldWrapper::importArray(array $a) $this Import an array of Inputfield definitions to to this InputfieldWrapper instance
InputfieldWrapper::insertAfter(Inputfield $item, Inputfield $existingItem) $this Insert one Inputfield after one that’s already there.
InputfieldWrapper::insertBefore(Inputfield $item, Inputfield $existingItem) $this Insert one Inputfield before one that’s already there.
InputfieldWrapper::populateValues($data) array Populate values for all Inputfields in this wrapper from the given $data object or array.
InputfieldWrapper::prepend(Inputfield $item) $this Prepend an Inputfield to this instance’s children.
InputfieldWrapper::remove($item) $this Remove an Inputfield from this instance’s children.

Retrieval and traversal

Name Return Summary  
InputfieldWrapper::children() InputfieldsArray Return all children Inputfield objects
Can also be used as property: InputfieldWrapper::children
InputfieldWrapper::count() int Return the quantity of children present
InputfieldWrapper::find(string $selector) InputfieldsArray Find all children Inputfields matching a selector string
InputfieldWrapper::get(string $key) Inputfield or mixed Get a child Inputfield having a name attribute matching the given $key.
InputfieldWrapper::getAll() InputfieldWrapper Get all Inputfields below this recursively in a flat InputfieldWrapper (children, and their children, etc.)
InputfieldWrapper::getChildByName(string $name) Inputfield or null Given an Inputfield name, return the child Inputfield or NULL if not found.
InputfieldWrapper::getErrors() array Return an array of errors that occurred on any of the children during input processing.
InputfieldWrapper::getIterator() InputfieldsArray Enables foreach() of the children of this class
InputfieldWrapper::isEmpty() bool Returns true if all children are empty, or false if one or more is populated

Output

Name Return Summary  
InputfieldWrapper::render() string Render this Inputfield and the output of its children.
InputfieldWrapper::renderInputfield(Inputfield $inputfield) string Render output for an individual Inputfield
InputfieldWrapper::renderValue() string Render the output of this Inputfield and its children, showing values only (no inputs)

Input

Name Return Summary  
InputfieldWrapper::getErrors() array Return an array of errors that occurred on any of the children during input processing.
InputfieldWrapper::processInput(WireInputData $input) $this Process input for all children

Module

Name Return Summary  
InputfieldWrapper::getConfigInputfields() InputfieldWrapper Get configuration Inputfields for this InputfieldWrapper

Additional methods and properties

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