FieldtypeFieldsetOpen

Each Fieldtype subdirectory (e.g

FieldtypeText/, FieldtypeImage/) has its own API.md. This file covers only the flat Fieldtype modules that have no subdirectory: FieldtypeFieldsetOpen, FieldtypeFieldsetTabOpen, and FieldtypeFieldsetClose.

FieldtypeFieldsetOpen

Opens a collapsible, bordered group of fields in the page editor. Fields placed between the open and its paired close field are visually grouped together.

Value type

None — stores no data.

How it works

Close fields are created, renamed, and deleted automatically alongside their paired open field. The close field is always named {opener_name}_END.

You only interact with close fields to position them within a template's field order — drag them to wherever you want the group to end.

Notes
  • Close fields appear under the "Advanced" filter in the Fields list.
  • Do not rename or delete close fields directly — manage them via the open field.
Settings
PropertyTypeDescription
modalboolOpen the tab in its own modal window. Useful for large forms where loading all tabs at once is slow. Default: false.

The collapsed option for tab fieldsets is limited to: always visible, or AJAX-loaded (the tab content loads only when the tab is clicked).

API reference: methods, hooks

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the FieldtypeFieldsetOpen class also inherits all the methods and properties of: Fieldtype, WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
FieldtypeFieldsetOpen::checkFieldgroupFieldsets(Fieldgroup $fieldgroup)
bool

Check that Fieldgroup has matching open/close fieldsets and in correct order

 
FieldtypeFieldsetOpen::getCompatibleFieldtypes($field)
None
FieldtypeFieldsetOpen::getConfigAdvancedInputfields($field)
None
FieldtypeFieldsetOpen::getConfigInputfields($field)
None
FieldtypeFieldsetOpen::getFieldsetCloseField(Field $field)
null Field

Get the Field that closes/terminates the given Fieldset field

 
FieldtypeFieldsetOpen::getFieldsetOpenField(Field $field)
null Field

Get the Field that opens the given FieldsetClose field

 
FieldtypeFieldsetOpen::getInputfield($page, $field)
None 
FieldtypeFieldsetOpen::getLoadQuery($field, $query)
None 
FieldtypeFieldsetOpen::loadPageField($page, $field)
None 
FieldtypeFieldsetOpen::sanitizeValue($page, $field, $value)
None 
FieldtypeFieldsetOpen::savePageField($page, $field)
None 

Additional methods and properties

In addition to the methods and properties above, FieldtypeFieldsetOpen also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.260