Skip to main content
Version: Next

Twig Operator (Grid Advanced Columns)

The Twig Operator is a grid transformer for Data Object Advanced Columns. It lets you compose one or more field values into a single, freely formatted cell by rendering a Twig template. Use it to build summary columns, concatenate fields, format dates and numbers, render small pieces of HTML, or apply conditional logic.

Where to find it in the UI​

  1. Open a Data Object grid and edit the column configuration.
  2. Add an Advanced Column (dataobject.advanced).
  3. Add one or more data sources (simpleField, relationField, or staticText). Every field you want to use in the template must be declared here.
  4. Add a Transformer and pick Twig Operator (listed under the Other group).
  5. Write your template in the Twig Template code field. The default is {{ value }}.

How the value variable is structured​

The template is rendered with exactly one variable, value. It is always a keyed map of field name → field value, with one entry per data source – even when the column has only a single data source. value is therefore never the bare value of a field; you always reach a field through its key.

This matters: printing the bare variable

{{ value }}

does not print a field value – it tries to stringify the whole map, which is almost never what you want. Always address a specific key, e.g. {{ value.name }}.

Direct fields (simpleField, staticText)​

A data source that is read directly from the object is exposed under its field name:

{{ value.name }}          {# from a simpleField with "field": "name" #}
{{ value.productionYear }}

Relation fields (relationField) – relation-aware nesting​

When a value is resolved through a relation, it is nested one level deeper, under the relation name. This lets you distinguish a field on the object itself from a same-named field on a related object:

Data sourceAccess in the template
simpleField field: name{{ value.name }}
relationField relation: manufacturer, field: name{{ value.manufacturer.name }}

So {{ value.name }} is the car's own name, while {{ value.manufacturer.name }} is the related manufacturer's name.

What each field contains​

The value of a key is the resolved field value as plain data – the operator deliberately passes plain strings/arrays rather than wrapped objects. Depending on the field type a key may hold:

  • a scalar (string / number / bool) – most input, numeric, select, date fields;
  • an array – multiselect fields, or relation fields that resolve multiple values;
  • a nested array – relation sub-fields, keyed by relation name (see above).

Available tags, functions & filters​

Templates are rendered inside a Twig sandbox. Only an explicit allow-list of tags, filters and functions is permitted. Anything else – arbitrary method calls, property access, include/source, etc. – is rejected and the template fails to render. This prevents arbitrary code execution and information disclosure through user-provided templates.

Out of the box this covers the common formatting building blocks: the if, for and set tags; functions such as date, max and min; and filters such as default, join, number_format, date, upper/lower and trim.

For detailed information, see Grid → TwigOperator Transformer in the Studio Backend documentation.

Examples​

Concatenate fields​

Data sources: simpleField: name, relationField relation: manufacturer, field: name.

{{ value.manufacturer.name }} {{ value.name }}

Format a number and a date​

{{ value.price|number_format(2, '.', ',') }} €
– built {{ value.productionDate|date('d.m.Y') }}

Provide a fallback for empty values​

{{ value.nickname|default('–') }}

Join a multiselect / multi-relation field​

{{ value.colors|join(', ') }}

Conditional rendering and loops​

{% if value.color is iterable %}
  <ul>
    {% for color in value.color %}<li>{{ color }}</li>{% endfor %}
  </ul>
{% else %}
  <em>No colors available.</em>
{% endif %}

Tips & tricks​

  • Guard against missing values with default and is defined: 
    {{ value.subtitle|default('') }}
    {% if value.manufacturer is defined %}{{ value.manufacturer.name }}{% endif %}
  • Check type before iterating. Single- vs multi-value fields differ; use is iterable before a for loop (see the example above).
  • Inspect unknown columns with {{ value|json_encode }} while building the template, then remove it.
  • Output is escaped by default. Twig auto-escapes for safety. Use raw only for values you fully trust, and only if raw is in your allow-list – it re-opens the door to XSS.
  • Format, don't compute. The sandbox blocks method/property calls on objects; keep templates to formatting and presentation. For logic that needs services or complex computation, use a PHP Code transformer instead.
  • Export-friendly. The rendered result is a string, so Twig Operator columns work in grid exports – but remember HTML markup will appear verbatim in CSV/XLSX output.
  • A failed template fails the column. Invalid Twig (or use of a disallowed tag/filter/function) raises an error instead of rendering – test incrementally.
  • Grid architecture & all transformers (backend reference, incl. the full sandbox policy and other transformers such as Combine, Blur, Translate, PHP Code): Grid in the Studio Backend documentation.