Fieldgroup class

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

Name	Return	Summary
Fieldgroup::get() Fieldgroup::get($key) Fieldgroup::get($key)	`Field` `string` `int` `null` `array`	Get a Fieldgroup property or a Field.
Fieldgroup::getField() Fieldgroup::getField($key) Fieldgroup::getField($key, $useFieldgroupContext = false)	`Field` `null`	Get a field that is part of this fieldgroup
Fieldgroup::getFieldContext() Fieldgroup::getFieldContext($key) Fieldgroup::getFieldContext($key, string $namespace = '')	`Field` `null`	Get a Field that is part of this Fieldgroup, in the context of this Fieldgroup.
Fieldgroup::getNumTemplates() Fieldgroup::getNumTemplates() Fieldgroup::getNumTemplates()	`int`	Get the number of templates using this Fieldgroup
Fieldgroup::getPageInputfields() Fieldgroup::getPageInputfields(Page $page) Fieldgroup::getPageInputfields(Page $page, $contextStr = '', $fieldName = '', string $namespace = '', bool $flat = true)	`InputfieldWrapper`	Get all of the Inputfields for this Fieldgroup associated with the provided Page and populate them.
Fieldgroup::getTemplates() Fieldgroup::getTemplates() Fieldgroup::getTemplates()	`TemplatesArray`	Get a list of all templates using this Fieldgroup
Fieldgroup::hasField() Fieldgroup::hasField($key) Fieldgroup::hasField($key)	`bool`	Does this fieldgroup have the given field?
Fieldgroup::hasFieldContext() Fieldgroup::hasFieldContext($field) Fieldgroup::hasFieldContext($field, string $namespace = '')	`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() Fieldgroup::add($item) Fieldgroup::add($item)	`$this`	Add a field to this Fieldgroup
Fieldgroup::remove() Fieldgroup::remove($key) Fieldgroup::remove($key)	`bool`	Remove a field from this fieldgroup
Fieldgroup::save() Fieldgroup::save() Fieldgroup::save()	`$this`	Save this Fieldgroup to the database
Fieldgroup::saveContext() Fieldgroup::saveContext() Fieldgroup::saveContext()	`int`	Save field contexts for this fieldgroup
Fieldgroup::set() Fieldgroup::set(string $key, $value) Fieldgroup::set(string $key, $value)	`Fieldgroup` `WireArray`	Set a fieldgroup property
Fieldgroup::softRemove() Fieldgroup::softRemove($field) Fieldgroup::softRemove($field)	`bool` `Fieldgroup` `WireArray`	Remove a field without queueing it to be removed from database

Properties

Name	Return	Summary
Fieldgroup::fields_id	`array`	Array of all field IDs in this Fieldgroup
Fieldgroup::removedFields	`null` `FieldsArray`	Null when there are no removed fields, or FieldsArray when there are.

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.252