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.

Show class?             Show args?        

Common

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

Retrieval

NameReturnSummary 
Fieldgroup::get($key)
Field string int null arrayGet a Fieldgroup property or a Field. 
Fieldgroup::getField($key)
Field nullGet a field that is part of this fieldgroup 
Fieldgroup::getFieldContext($key)
Field 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 have 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  

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

Twitter updates

  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021

Latest news

  • ProcessWire Weekly #370
    In the 370th issue of ProcessWire Weekly we're going to check out the latest version of the commercial FormBuilder module, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 12 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull