Skip to content

Group ​

A Group bundles fields that belong together but appear once per entry: an "Address" group with street, city and postcode, or a "Contact" group with phone, email and website.

Grouping keeps the form tidy, and it also keeps keys simple: the fields inside only need names that are unique within the group, so a "Billing address" group and a "Shipping address" group can each have a city.

You add the fields on the group's Sub Fields tab. Almost any field type can go inside, including another Group or a Repeater.

A group changes how its fields are stored. To only show some top-level fields together, or hide them as a set, use a Section instead: it arranges fields without changing their keys.

A group is saved as one value. When you read it in a template, you get all of its fields together: @post(address.city) in VX Script, or $post->field( 'address' )->group() in PHP.

Technical details for LLMs
  • Type key: group. Settings: fields (sub-field configs).
  • Not allowed inside: post_relation, user_relation.
  • Stored: one meta value under the group key holding every sub-field, keyed by sub-field key.
  • Abilities write: the whole object; sub-keys you leave out are cleared, not preserved. A group with a password descendant can't be written through the abilities.
  • PHP: ->group() → Field_Row (->field( 'city' )).

Documentation for the VX Framework.