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

Show “Fieldgroup”             Show Arguments        

Retrieval

NameReturnSummary 
Fieldgroup::get($key)
Field, string, int or nullGet a Fieldgroup property or a Field.
Fieldgroup::getField($key)
Field or nullGet a field that is part of this fieldgroup
Fieldgroup::getFieldContext($key)
Field or nullGet a Field that is part of this Fieldgroup, in the context of this Fieldgroup.
Fieldgroup::getNumTemplates()
intGet the number of templates using this Fieldgroup
Fieldgroup::getPageInputfields(Page $page)
InputfieldWrapperGet all of the Inputfields for this Fieldgroup associated with the provided Page and populate them.
Fieldgroup::getTemplates()
TemplatesArrayGet a list of all templates using this Fieldgroup
Fieldgroup::hasField($key)
boolDoes this fieldgroup having the given field?
Fieldgroup::hasFieldContext($field)
boolDoes the given Field have context data available in this fieldgroup?
Fieldgroup::id int Fieldgroup database ID
Fieldgroup::name string Fieldgroup name

Manipulation

NameReturnSummary 
Fieldgroup::add($field)
$thisAdd a field to this Fieldgroup
Fieldgroup::remove($field)
boolRemove a field from this fieldgroup
Fieldgroup::save()
$thisSave this Fieldgroup to the database
Fieldgroup::saveContext()
intSave field contexts for this fieldgroup
Fieldgroup::set(string $key, $value)
FieldgroupSet a fieldgroup property
Fieldgroup::softRemove($field)
boolRemove 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:

API reference based on ProcessWire core version 3.0.62