Fieldgroup is a type of WireArray that holds a group of Field objects for template(s).

For full details on all methods available in a Fieldgroup, be sure to also see the WireArray class.


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

Retrieval / Manipulation

Retrieval

Name Return Summary  
Fieldgroup::get($key) Field, string, int or null Get a Fieldgroup property or a Field.
Fieldgroup::getField($key) Field or null Get a field that is part of this fieldgroup
Fieldgroup::getFieldContext($key) Field or null Get a Field that is part of this Fieldgroup, in the context of this Fieldgroup.
Fieldgroup::getNumTemplates() int Get the number of templates using this Fieldgroup
Fieldgroup::getPageInputfields(Page $page) InputfieldWrapper Get all of the Inputfields for this Fieldgroup associated with the provided Page and populate them.
Fieldgroup::getTemplates() TemplatesArray Get a list of all templates using this Fieldgroup
Fieldgroup::hasField($key) bool Does this fieldgroup having the given field?
Fieldgroup::hasFieldContext($field) bool Does the given Field have context data available in this fieldgroup?
Fieldgroup::id int Fieldgroup database ID
Fieldgroup::name string Fieldgroup name

Manipulation

Name Return Summary  
Fieldgroup::add($field) $this Add a field to this Fieldgroup
Fieldgroup::remove($field) bool Remove a field from this fieldgroup
Fieldgroup::save() $this Save this Fieldgroup to the database
Fieldgroup::saveContext() int Save field contexts for this fieldgroup
Fieldgroup::set(string $key, $value) Fieldgroup Set a fieldgroup property
Fieldgroup::softRemove($field) bool Remove a field without queueing it to be removed from database

Additional methods and properties

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