Accessing Form Errors

..versionadded::2.5

Before Symfony 2.5, ``getErrors()`` returned an array of ``FormError``

objects. The return value was changed to ``FormErrorIterator`` in Symfony

2.5.

You can use the:method:`Symfony\\Component\\Form\\FormInterface::getErrors`

method to access the list of errors.Each element is a:class:`Symfony\\Component\\Form\\FormError`

object::

method to access the list of errors.It returns a

:class:`Symfony\\Component\\Form\\FormErrorIterator` instance::

errors from that field. However, there is no way to determine which field

an error was originally attached to.

..note::

..tip::

In older Symfony versions, ``getErrors()`` returned an array. To use the

errors the same way in Symfony 2.5 or newer, you have to pass them to

PHP's:phpfunction:`iterator_to_array` function::

This is useful, for example, if you want to use PHP's ``array_`` function

on the form errors.

Child Form Errors

..versionadded::2.5

The ``$deep`` and ``$flatten`` arguments were introduced in Symfony 2.5.

By default, ``getErrors()`` only returns the errors of the form object it

was called on. To also include the errors of child forms, you'll have to pass

``true`` as the first argument to it::

You can use the:method:`Symfony\\Component\\Form\\FormError::getOrigin` method

on each element returned by the ``FormErrorIterator`` to determine the form

the error belongs to.

You can also let the iterator reflect the form tree structure. To achieve

this, pass ``false`` as the second argument to ``getErrors()``. The iterator

then returns a ``FormErrorIterator`` object for each child form instead of

multiple ``FormError`` childs. You can easily use a:phpclass:`RecursiveIteratorIterator`

to iterate over all errors::

Unless you enable the:ref:`error_bubbling<reference-form-option-error-bubbling>`

option on a particular child form, ``getErrors()`` only returns the errors

of the form it is accessed on. For debugging purposes, you can use the:method:`Symfony\\Component\\Form\\Form::getErrorsAsString` method which

returns a string representation of all errors of the whole form tree.

.. _Packagist:https://packagist.org/packages/symfony/form

.. _Twig:http://twig.sensiolabs.org

..include::/reference/forms/types/options/empty_data.rst.inc

:start-after: DEFAULT_PLACEHOLDER

.. _reference-form-option-error-bubbling:

..include::/reference/forms/types/options/error_bubbling.rst.inc

..include::/reference/forms/types/options/error_mapping.rst.inc