$fieldgroups

Maintains collections of Fieldgroup object instances and represents the `$fieldgroups` API variable.

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 Fieldgroups class also inherits all the methods and properties of: WireSaveableItemsLookup, WireSaveableItems and Wire.

Common
For hooks

Common

Name	Return	Summary
$fieldgroups->clone() $fieldgroups->clone(Saveable $item) $fieldgroups->clone(Saveable $item, string $name = '')	`Fieldgroup` `false`	Create and return a cloned copy of this item
$fieldgroups->delete() $fieldgroups->delete($item) $fieldgroups->delete($item)	`bool`	Delete the given fieldgroup from the database
$fieldgroups->deleteField() $fieldgroups->deleteField(Field $field) $fieldgroups->deleteField(Field $field)	`bool`	Delete the entries in fieldgroups_fields for the given Field
$fieldgroups->getAll() $fieldgroups->getAll() $fieldgroups->getAll()	`FieldgroupsArray`	Per WireSaveableItems interface, return all available Fieldgroup instances
$fieldgroups->getExportData() $fieldgroups->getExportData(Fieldgroup $fieldgroup) $fieldgroups->getExportData(Fieldgroup $fieldgroup)	`array`	Export config data for the given fieldgroup
$fieldgroups->getFieldNames() $fieldgroups->getFieldNames($fieldgroup) $fieldgroups->getFieldNames($fieldgroup)	`array`	Get all field names used by given fieldgroup
$fieldgroups->getLookupTable() $fieldgroups->getLookupTable() $fieldgroups->getLookupTable()	`string`	Per WireSaveableItemsLookup interface, return the name of the table that Fields are linked to Fieldgroups
$fieldgroups->getNumTemplates() $fieldgroups->getNumTemplates(Fieldgroup $fieldgroup) $fieldgroups->getNumTemplates(Fieldgroup $fieldgroup)	`int`	Get the number of templates using the given fieldgroup.
$fieldgroups->getTable() $fieldgroups->getTable() $fieldgroups->getTable()	`string`	Per WireSaveableItems interface, return the name of the table that Fieldgroup instances are stored in
$fieldgroups->getTemplates() $fieldgroups->getTemplates(Fieldgroup $fieldgroup) $fieldgroups->getTemplates(Fieldgroup $fieldgroup)	`TemplatesArray`	Given a Fieldgroup, return a TemplatesArray of all templates using the Fieldgroup
$fieldgroups->getWireArray() $fieldgroups->getWireArray() $fieldgroups->getWireArray()	`WireArray` `FieldgroupsArray`	@return WireArray\|FieldgroupsArray
$fieldgroups->init() $fieldgroups->init() $fieldgroups->init()	None	Init
$fieldgroups->makeBlankItem() $fieldgroups->makeBlankItem() $fieldgroups->makeBlankItem()	`Fieldgroup`	Per WireSaveableItems interface, create a blank instance of a Fieldgroup
$fieldgroups->save() $fieldgroups->save(Saveable $item) $fieldgroups->save(Saveable $item)	`bool`	Save the Fieldgroup to DB
$fieldgroups->saveContext() $fieldgroups->saveContext(Fieldgroup $fieldgroup) $fieldgroups->saveContext(Fieldgroup $fieldgroup)	`int`	Save contexts for all fields in the given fieldgroup
$fieldgroups->setImportData() $fieldgroups->setImportData(Fieldgroup $fieldgroup, array $data) $fieldgroups->setImportData(Fieldgroup $fieldgroup, array $data)	`array`	Given an export data array, import it back to the class and return what happened

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
$fieldgroups->fieldAdded() $fieldgroups->fieldAdded(Fieldgroup $fieldgroup, Field $field) $fieldgroups->fieldAdded(Fieldgroup $fieldgroup, Field $field)	None	Hook called when field has been added to fieldgroup
$fieldgroups->fieldRemoved() $fieldgroups->fieldRemoved(Fieldgroup $fieldgroup, Field $field) $fieldgroups->fieldRemoved(Fieldgroup $fieldgroup, Field $field)	None	Hook called when field has been removed from fieldgroup

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.253