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

Twitter updates

  • ProcessWire 3.0.162 continues improvements to selector operators, fixes various minor issues, adds new API convenience methods, improves documentation, optimizes and refactors various portions of code and DB queries, and more— More
    10 July 2020
  • New dedicated page in our online documentation for Selector Operators: More
    10 July 2020
  • New ProcessWire query expansion search operators can now add automatic word inflections and lemmatisation, enabling you to build even smarter search engines with ProcessWire. More
    3 July 2020

Latest news

  • ProcessWire Weekly #322
    In the 322nd issue of ProcessWire Weekly we're going to focus on the latest core updates, take a closer look at the newly released Wire Text Tools (EN) module, and introduce a brand new site of the week. Read on!
    Weekly.pw / 11 July 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer