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

Twitter updates

  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020
  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020

Latest news

  • ProcessWire Weekly #308
    In the 308th issue of ProcessWire Weekly we're going to take a look at some upcoming core and pro module updates, check out two all-new third party modules, and more. Read on!
    Weekly.pw / 4 April 2020
  • ProcessWire updates and additions in progress
    This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks. This post covers all the details.
    Blog / 3 April 2020
  • 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