Form Rendering Functions

This reference manual covers all the possible Twig functions available for rendering forms. There are several different functions available, and each is responsible for rendering a different part of a form (e.g. labels, errors, widgets, etc).

form_label(view, label, variables)

Renders the label for the given field. You can optionally pass the specific label you want to display as the second argument.

1
2
3
4
5

{{ form_label(form.name) }}

{# The two following syntaxes are equivalent #}
{{ form_label(form.name, 'Your Name', { 'attr': {'class': 'foo'} }) }}
{{ form_label(form.name, null, { 'label': 'Your name', 'attr': {'class': 'foo'} }) }}

See "Twig Template Form Function and Variable Reference" to learn about the variables argument.

form_errors(view)

Renders any errors for the given field.

1
2
3
4

{{ form_errors(form.name) }}

{# render any "global" errors #}
{{ form_errors(form) }}

form_widget(view, variables)

Renders the HTML widget of a given field. If you apply this to an entire form or collection of fields, each underlying form row will be rendered.

1
2

{# render a widget, but add a "foo" class to it #}
{{ form_widget(form.name, { 'attr': {'class': 'foo'} }) }}

The second argument to form_widget is an array of variables. The most common variable is attr, which is an array of HTML attributes to apply to the HTML widget. In some cases, certain types also have other template-related options that can be passed. These are discussed on a type-by-type basis. The attributes are not applied recursively to child fields if you're rendering many fields at once (e.g. form_widget(form)).

See "Twig Template Form Function and Variable Reference" to learn more about the variables argument.

form_row(view, variables)

Renders the "row" of a given field, which is the combination of the field's label, errors and widget.

1
2

{# render a field row, but display a label with text "foo" #}
{{ form_row(form.name, { 'label': 'foo' }) }}

The second argument to form_row is an array of variables. The templates provided in Symfony only allow to override the label as shown in the example above.

See "Twig Template Form Function and Variable Reference" to learn about the variables argument.

form_rest(view, variables)

This renders all fields that have not yet been rendered for the given form. It's a good idea to always have this somewhere inside your form as it'll render hidden fields for you and make any fields you forgot to render more obvious (since it'll render the field for you).

1

{{ form_rest(form) }}

form_enctype(view)

If the form contains at least one file upload field, this will render the required enctype="multipart/form-data" form attribute. It's always a good idea to include this in your form tag:

1

<form action="{{ path('form_submit') }}" method="post" {{ form_enctype(form) }}>

More about Form Variables

In almost every Twig function above, the final argument is an array of "variables" that are used when rendering that one part of the form. For example, the following would render the "widget" for a field, and modify its attributes to include a special class:

1
2

{# render a widget, but add a "foo" class to it #}
{{ form_widget(form.name, { 'attr': {'class': 'foo'} }) }}

The purpose of these variables - what they do & where they come from - may not be immediately clear, but they're incredibly powerful. Whenever you render any part of a form, the block that renders it makes use of a number of variables. By default, these blocks live inside form_div_layout.html.twig.

Look at the generic_label as an example:

1
2
3
4
5
6

{% block generic_label %}
    {% if required %}
        {% set attr = attr|merge({'class': attr.class|default('') ~ ' required'}) %}
    {% endif %}
    <label{% for attrname,attrvalue in attr %} {{attrname}}="{{attrvalue}}"{% endfor %}>{{ label|trans }}</label>
{% endblock %}

This block makes use of 3 variables: required, attr and label. These variables are made available by the form rendering system. But more importantly, these are the variables that you can override when calling form_label (since in this example, you're rendering the label).

The exact variables available to override depends on which part of the form you're rendering (e.g. label versus widget) and which field you're rendering (e.g. a choice widget has an extra expanded option). If you get comfortable with looking through form_div_layout.html.twig, you'll always be able to see what options you have available.

1
2

{# does **not** work - the variables are not recursive #}
{{ form_widget(form, { 'attr': {'class': 'foo'} }) }}

1
2
3
4

<label for="{{ form.name.vars.id }}"
    class="{{ form.name.vars.required ? 'required' : '' }}">
    {{ form.name.vars.label }}
</label>

1
2
3
4

<label for="<?php echo $view['form']->get('name')->vars['id'] ?>"
    class="<?php echo $view['form']->get('name')->vars['required'] ? 'required' : '' ?>">
    <?php echo $view['form']->get('name')->vars['label'] ?>
</label>