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

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #402
    In the 402nd issue of ProcessWire Weekly we'll check out ProcessWire 3.0.193, highlight recent ProcessWire projects and resources, and more. Read on!
    Weekly.pw / 22 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer