Skip to content

Commit

Permalink
feature #4465 Modifying the best practice to use form_start() instead…
Browse files Browse the repository at this point in the history
… of <form (weaverryan, WouterJ)

This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #4465).

Discussion
----------

Modifying the best practice to use form_start() instead of <form

| Q   | A
| --- | ---
| Doc fix? | no
| New docs? | no
| Applies to | 2.3+
| Fixed tickets | #4402

Hi guys!

See #4402. This proposes recommending to use `form_start` for the reasons there. There are pros and cons, but after nice chat, I think the pros outweigh the cons.

/cc @webmozart

Thanks!

Commits
-------

ae3b3cd Fixed typo
f1708f5 Modifying the best practice to use form_start() instead of <form
  • Loading branch information
weaverryan committed Nov 20, 2014
2 parents 0a21446 + ae3b3cd commit 422e0f1
Showing 1 changed file with 5 additions and 19 deletions.
24 changes: 5 additions & 19 deletions best_practices/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,29 +157,15 @@ There are a lot of ways to render your form, ranging from rendering the entire
thing in one line to rendering each part of each field independently. The
best way depends on how much customization you need.

The simplest way - which is especially useful during development - is to render
the form tags manually and then use ``form_widget()`` to render all of the fields:
One of the simplest ways - which is especially useful during development -
is to render the form tags and use ``form_widget()`` to render all of the
fields:

.. code-block:: html+jinja

<form method="POST" {{ form_enctype(form) }}>
{{ form_start(form, {'attr': {'class': 'my-form-class'} }) }}
{{ form_widget(form) }}
</form>

.. best-practice::

Don't use the ``form()`` or ``form_start()`` functions to render the
starting and ending form tags.

Experienced Symfony developers will recognize that we're rendering the ``<form>``
tags manually instead of using the ``form_start()`` or ``form()`` functions.
While those are convenient, they take away from some clarity with little
benefit.

.. tip::

The exception is a delete form because it's really just one button and
so benefits from some of these extra shortcuts.
{{ form_end(form) }}

If you need more control over how your fields are rendered, then you should
remove the ``form_widget(form)`` function and render your fields individually.
Expand Down

0 comments on commit 422e0f1

Please sign in to comment.