Skip to content

[Form] Add some basic docs for Twig Form field helpers #18191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 4, 2023
Merged

[Form] Add some basic docs for Twig Form field helpers #18191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions form/form_customization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,49 @@ control over how each form field is rendered, so you can fully customize them:
Later in this article you can find the full reference of these Twig
functions with more usage examples.

.. _reference-forms-twig-field-helpers:

Form Field Helpers
------------------

The ``form_*()`` helpers render each part of the form field, including all its needed HTML elements. Most developers
like this behavior, but some designers struggle with it, because it hides all the HTML in form themes which are not
easy to manage by them.

That's why some Twig form helpers are available to render the value of each form field part without adding any
HTML around it:

* ``field_name``
* ``field_value``
* ``field_label``
* ``field_help``
* ``field_errors``
* ``field_choices`` (an iterator of the field choices; e.g. for ``<select>``)

When using these helpers, you must write all the HTML contents for all form fields, which some people prefer to better
control the generated HTML without having to deal with form themes:

.. code-block:: html+twig

<input
name="{{ field_name(form.username) }}"
value="{{ field_value(form.username) }}"
placeholder="{{ field_label(form.username) }}"
class="form-control"
/>

<select name="{{ field_name(form.country) }}" class="form-control">
<option value="">{{ field_label(form.country) }}</option>

{% for label, value in field_choices(form.country) %}
<option value="{{ value }}">{{ label }}</option>
{% endfor %}
</select>

.. versionadded:: 5.2

The ``field_*()`` helpers were introduced in Symfony 5.2.

Form Rendering Variables
------------------------

Expand Down
6 changes: 6 additions & 0 deletions reference/twig_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,12 @@ explained in the article about :doc:`customizing form rendering </form/form_cust
* :ref:`form_help() <reference-forms-twig-help>`
* :ref:`form_row() <reference-forms-twig-row>`
* :ref:`form_rest() <reference-forms-twig-rest>`
* :ref:`field_name() <reference-forms-twig-field-helpers>`
* :ref:`field_value() <reference-forms-twig-field-helpers>`
* :ref:`field_label() <reference-forms-twig-field-helpers>`
* :ref:`field_help() <reference-forms-twig-field-helpers>`
* :ref:`field_errors() <reference-forms-twig-field-helpers>`
* :ref:`field_choices() <reference-forms-twig-field-helpers>`

.. _reference-twig-filters:

Expand Down