diff --git a/form/form_customization.rst b/form/form_customization.rst index f50325bfc09..c1a3ee32061 100644 --- a/form/form_customization.rst +++ b/form/form_customization.rst @@ -36,6 +36,7 @@ You can also render each of the three parts of the field individually: {{ form_label(form.age) }} {{ form_errors(form.age) }} {{ form_widget(form.age) }} + {{ form_help(form.age) }} .. code-block:: php @@ -796,6 +797,7 @@ You can also override the markup for an entire field row using the same method: {{ form_label(form) }} {{ form_errors(form) }} {{ form_widget(form) }} + {{ form_help(form) }} {% endblock %} @@ -1024,6 +1026,7 @@ class to the ``div`` element around each row: {{ form_label(form) }} {{ form_errors(form) }} {{ form_widget(form) }} + {{ form_help(form) }} {% endblock form_row %} diff --git a/form/form_themes.rst b/form/form_themes.rst index dbc9f35bc0c..99001e96d44 100644 --- a/form/form_themes.rst +++ b/form/form_themes.rst @@ -35,6 +35,7 @@ do this, create a new template file that will store the new markup: {{ form_label(form) }} {{ form_errors(form) }} {{ form_widget(form) }} + {{ form_help(form) }} {% endspaceless %} {% endblock form_row %} @@ -135,6 +136,8 @@ are 4 possible *parts* of a form that can be rendered: +-------------+----------------------------+---------------------------------------------------------+ | ``errors`` | (e.g. ``form_errors()``) | renders the field's errors | +-------------+----------------------------+---------------------------------------------------------+ +| ``help`` | (e.g. ``form_help()``) | renders the field's help | ++-------------+----------------------------+---------------------------------------------------------+ | ``row`` | (e.g. ``form_row()``) | renders the field's entire row (label, widget & errors) | +-------------+----------------------------+---------------------------------------------------------+ diff --git a/form/rendering.rst b/form/rendering.rst index 5483a33748a..162227d7a45 100644 --- a/form/rendering.rst +++ b/form/rendering.rst @@ -82,12 +82,14 @@ used the ``form_row()`` helper: {{ form_label(form.task) }} {{ form_errors(form.task) }} {{ form_widget(form.task) }} + {{ form_help(form.task) }}
{{ form_label(form.dueDate) }} {{ form_errors(form.dueDate) }} {{ form_widget(form.dueDate) }} + {{ form_help(form.dueDate) }}
diff --git a/reference/forms/types/birthday.rst b/reference/forms/types/birthday.rst index 056fe21ad3e..6d18eeddc70 100644 --- a/reference/forms/types/birthday.rst +++ b/reference/forms/types/birthday.rst @@ -38,6 +38,7 @@ option defaults to 120 years ago to the current year. | | | | | - `data`_ | | | - `disabled`_ | +| | - `help`_ | | | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | @@ -108,6 +109,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/inherit_data.rst.inc .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index 8f87683f180..08c1a6bddd2 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -20,6 +20,7 @@ true, if the box is unchecked, the value will be set to false. | options | - `disabled`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -69,6 +70,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst index a2790af5c0d..ae67238b875 100644 --- a/reference/forms/types/choice.rst +++ b/reference/forms/types/choice.rst @@ -34,6 +34,7 @@ To use this field, you must specify *either* ``choices`` or ``choice_loader`` op | | - `data`_ | | | - `disabled`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `inherit_data`_ | | | - `label`_ | | | - `label_attr`_ | @@ -264,6 +265,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/inherit_data.rst.inc .. include:: /reference/forms/types/options/label.rst.inc diff --git a/reference/forms/types/collection.rst b/reference/forms/types/collection.rst index 10e67c56c40..687a04ef62f 100644 --- a/reference/forms/types/collection.rst +++ b/reference/forms/types/collection.rst @@ -27,6 +27,7 @@ photos). | options | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -448,6 +449,8 @@ error_bubbling .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/color.rst b/reference/forms/types/color.rst index dd7c39923ad..799d826538b 100644 --- a/reference/forms/types/color.rst +++ b/reference/forms/types/color.rst @@ -22,6 +22,7 @@ element. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -55,6 +56,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/country.rst b/reference/forms/types/country.rst index 0e2d35aeda2..c019120894b 100644 --- a/reference/forms/types/country.rst +++ b/reference/forms/types/country.rst @@ -38,6 +38,7 @@ the option manually, but then you should just use the ``ChoiceType`` directly. | | - `data`_ | | | - `disabled`_ | | | - `empty_data`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -100,6 +101,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/currency.rst b/reference/forms/types/currency.rst index af0f623a3b7..4870eb33e71 100644 --- a/reference/forms/types/currency.rst +++ b/reference/forms/types/currency.rst @@ -30,6 +30,7 @@ manually, but then you should just use the ``ChoiceType`` directly. | | - `data`_ | | | - `disabled`_ | | | - `empty_data`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -89,6 +90,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/date.rst b/reference/forms/types/date.rst index feca602bac1..cac20deb225 100644 --- a/reference/forms/types/date.rst +++ b/reference/forms/types/date.rst @@ -35,6 +35,7 @@ and can understand a number of different input formats via the `input`_ option. | Inherited | - `data`_ | | options | - `disabled`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | @@ -206,6 +207,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/inherit_data.rst.inc .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/dateinterval.rst b/reference/forms/types/dateinterval.rst index fdd6a6f19ac..450e14c3132 100644 --- a/reference/forms/types/dateinterval.rst +++ b/reference/forms/types/dateinterval.rst @@ -39,6 +39,7 @@ or an array (see `input`_). +----------------------+----------------------------------------------------------------------------------+ | Inherited | - `data`_ | | options | - `disabled`_ | +| | - `help`_ | | | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | @@ -307,6 +308,8 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/inherit_data.rst.inc .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/datetime.rst b/reference/forms/types/datetime.rst index 5791ef15bfb..d27404f905f 100644 --- a/reference/forms/types/datetime.rst +++ b/reference/forms/types/datetime.rst @@ -42,6 +42,7 @@ the data can be a ``DateTime`` object, a string, a timestamp or an array. +----------------------+-----------------------------------------------------------------------------+ | Inherited | - `data`_ | | options | - `disabled`_ | +| | - `help`_ | | | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | @@ -194,6 +195,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/inherit_data.rst.inc .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/email.rst b/reference/forms/types/email.rst index 70ee3e6036e..67eb149506c 100644 --- a/reference/forms/types/email.rst +++ b/reference/forms/types/email.rst @@ -15,6 +15,7 @@ The ``EmailType`` field is a text field that is rendered using the HTML5 | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -48,6 +49,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/entity.rst b/reference/forms/types/entity.rst index c323d4a2b6b..16ccb51006a 100644 --- a/reference/forms/types/entity.rst +++ b/reference/forms/types/entity.rst @@ -40,6 +40,7 @@ objects from the database. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -303,6 +304,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/file.rst b/reference/forms/types/file.rst index 9a62063eaf1..158a68e1aed 100644 --- a/reference/forms/types/file.rst +++ b/reference/forms/types/file.rst @@ -18,6 +18,7 @@ The ``FileType`` represents a file input in your form. | Inherited | - `disabled`_ | | options | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -124,6 +125,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index b71fb0d658e..7151415d32c 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -19,6 +19,7 @@ on all types for which ``FormType`` is the parent. | | - `error_bubbling`_ | | | - `error_mapping`_ | | | - `extra_fields_message`_ | +| | - `help`_ | | | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | @@ -98,6 +99,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/extra_fields_message.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/inherit_data.rst.inc .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/integer.rst b/reference/forms/types/integer.rst index 1b87d8f690e..f41acbd40e5 100644 --- a/reference/forms/types/integer.rst +++ b/reference/forms/types/integer.rst @@ -28,6 +28,7 @@ integers. By default, all non-integer values (e.g. 6.78) will round down | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | | | - `label`_ | @@ -103,6 +104,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/invalid_message.rst.inc .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc diff --git a/reference/forms/types/language.rst b/reference/forms/types/language.rst index b197405ccf9..024139df8c7 100644 --- a/reference/forms/types/language.rst +++ b/reference/forms/types/language.rst @@ -40,6 +40,7 @@ manually, but then you should just use the ``ChoiceType`` directly. | | - `data`_ | | | - `disabled`_ | | | - `empty_data`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -102,6 +103,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/locale.rst b/reference/forms/types/locale.rst index 5a332e4c1f9..224f6847190 100644 --- a/reference/forms/types/locale.rst +++ b/reference/forms/types/locale.rst @@ -41,6 +41,7 @@ manually, but then you should just use the ``ChoiceType`` directly. | | - `data`_ | | | - `disabled`_ | | | - `empty_data`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -103,6 +104,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/money.rst b/reference/forms/types/money.rst index 3f6af5941ef..8f7e7f888d3 100644 --- a/reference/forms/types/money.rst +++ b/reference/forms/types/money.rst @@ -27,6 +27,7 @@ how the input and output of the data is handled. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | | | - `label`_ | @@ -115,6 +116,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/invalid_message.rst.inc .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc diff --git a/reference/forms/types/number.rst b/reference/forms/types/number.rst index 843ef81e51e..0b7028cd579 100644 --- a/reference/forms/types/number.rst +++ b/reference/forms/types/number.rst @@ -23,6 +23,7 @@ that you want to use for your number. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | | | - `label`_ | @@ -98,6 +99,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/invalid_message.rst.inc .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc diff --git a/reference/forms/types/options/help.rst.inc b/reference/forms/types/options/help.rst.inc new file mode 100644 index 00000000000..e207e483a0b --- /dev/null +++ b/reference/forms/types/options/help.rst.inc @@ -0,0 +1,12 @@ +help +~~~~ + +**type**: ``string`` **default**: null + +Allows you to define extra information about the field, which will be rendered below the form field by default. + +.. code-block:: php + + $builder->add('name', null, array( + 'help' => 'My helper message.', + )); diff --git a/reference/forms/types/password.rst b/reference/forms/types/password.rst index b2491a31015..ea42aa6ffde 100644 --- a/reference/forms/types/password.rst +++ b/reference/forms/types/password.rst @@ -18,6 +18,7 @@ The ``PasswordType`` field renders an input password text box. | options | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -77,6 +78,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/percent.rst b/reference/forms/types/percent.rst index c06e97dd17a..8d823c34272 100644 --- a/reference/forms/types/percent.rst +++ b/reference/forms/types/percent.rst @@ -25,6 +25,7 @@ This field adds a percentage sign "``%``" after the input box. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | | | - `label`_ | @@ -95,6 +96,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/invalid_message.rst.inc .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc diff --git a/reference/forms/types/radio.rst b/reference/forms/types/radio.rst index 87cbbdfda5a..e53a19aae12 100644 --- a/reference/forms/types/radio.rst +++ b/reference/forms/types/radio.rst @@ -27,6 +27,7 @@ If you want to have a boolean field, use :doc:`CheckboxType `: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/range.rst b/reference/forms/types/range.rst index a59082adb78..c8a21093211 100644 --- a/reference/forms/types/range.rst +++ b/reference/forms/types/range.rst @@ -16,6 +16,7 @@ The ``RangeType`` field is a slider that is rendered using the HTML5 | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `mapped`_ | @@ -65,6 +66,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/repeated.rst b/reference/forms/types/repeated.rst index 3a100827ee6..c146683e34f 100644 --- a/reference/forms/types/repeated.rst +++ b/reference/forms/types/repeated.rst @@ -24,6 +24,7 @@ accuracy. +-------------+------------------------------------------------------------------------+ | Inherited | - `data`_ | | options | - `error_mapping`_ | +| | - `help`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | | | - `mapped`_ | @@ -194,6 +195,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/invalid_message.rst.inc .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc diff --git a/reference/forms/types/search.rst b/reference/forms/types/search.rst index 37f7f69da44..9bac82be97c 100644 --- a/reference/forms/types/search.rst +++ b/reference/forms/types/search.rst @@ -16,6 +16,7 @@ Read about the input search field at `DiveIntoHTML5.info`_ | options | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -47,6 +48,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/tel.rst b/reference/forms/types/tel.rst index a409978b7ad..4f08adfaed4 100644 --- a/reference/forms/types/tel.rst +++ b/reference/forms/types/tel.rst @@ -21,6 +21,7 @@ to input phone numbers. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -54,6 +55,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/text.rst b/reference/forms/types/text.rst index fd61506659d..24054cc2f29 100644 --- a/reference/forms/types/text.rst +++ b/reference/forms/types/text.rst @@ -14,6 +14,7 @@ The TextType field represents the most basic input text field. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -50,6 +51,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/textarea.rst b/reference/forms/types/textarea.rst index 7a811a5f67d..3b4d50d3c4d 100644 --- a/reference/forms/types/textarea.rst +++ b/reference/forms/types/textarea.rst @@ -15,6 +15,7 @@ Renders a ``textarea`` HTML element. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -56,6 +57,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/time.rst b/reference/forms/types/time.rst index e6b766f8b91..c3e396fc765 100644 --- a/reference/forms/types/time.rst +++ b/reference/forms/types/time.rst @@ -36,6 +36,7 @@ stored as a ``DateTime`` object, a string, a timestamp or an array. | Inherited | - `data`_ | | Options | - `disabled`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | @@ -193,6 +194,8 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/inherit_data.rst.inc .. include:: /reference/forms/types/options/invalid_message.rst.inc diff --git a/reference/forms/types/timezone.rst b/reference/forms/types/timezone.rst index 46ff16cd949..8614a39f7cb 100644 --- a/reference/forms/types/timezone.rst +++ b/reference/forms/types/timezone.rst @@ -37,6 +37,7 @@ manually, but then you should just use the ``ChoiceType`` directly. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -120,6 +121,8 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/forms/types/url.rst b/reference/forms/types/url.rst index 8c58f007e1d..38aa1732145 100644 --- a/reference/forms/types/url.rst +++ b/reference/forms/types/url.rst @@ -18,6 +18,7 @@ have a protocol. | | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `help`_ | | | - `label`_ | | | - `label_attr`_ | | | - `label_format`_ | @@ -63,6 +64,8 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/help.rst.inc + .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc diff --git a/reference/twig_reference.rst b/reference/twig_reference.rst index 0d802775b01..b3bbc703734 100644 --- a/reference/twig_reference.rst +++ b/reference/twig_reference.rst @@ -232,6 +232,18 @@ form_label Renders the label for the given field, more information in :ref:`the Twig Form reference `. +form_help +~~~~~~~~~~ + +.. code-block:: twig + + {{ form_help(view) }} + +``view`` + **type**: ``FormView`` + +Renders the help text for the given field. + form_row ~~~~~~~~