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

Twitter updates

  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020
  • ProcessWire 3.0.165 core updates (master and dev branch) and reCAPTCHA for FormBuilder module— More
    21 August 2020

Latest news

  • ProcessWire Weekly #331
    In the 331st issue of ProcessWire Weekly we're going to check out the latest core and Pro module updates (ProcessWire 3.0.166, ProCache 4.0.1, and Form Builder v44), introduce the Wireframe API module, and more. Read on!
    Weekly.pw / 12 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer