Skip to content

[Form] Ability to clear form errors #9916

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 3 commits into from
Jun 25, 2018
Merged

[Form] Ability to clear form errors #9916

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4143f1
[Form] Ability to clear form errors
colinodell Jun 11, 2018
7a4465d
Clarify that clearing errors makes the form valid
colinodell Jun 18, 2018
f07f536
Wrap long lines and add the versionadded directive
javiereguiluz Jun 25, 2018
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
7 changes: 7 additions & 0 deletions components/form.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -744,6 +744,13 @@ method to access the list of errors. It returns a
// a FormErrorIterator instance representing the form tree structure
$errors = $form->getErrors(true, false);

Clearing Form Errors
~~~~~~~~~~~~~~~~~~~~

Any errors can be manually cleared using the :method:`Symfony\\Component\\Form\\ClearableErrorsInterface::clearErrors` method. This is useful when you'd like to validate the form without showing validation errors to the user (i.e. during a partial AJAX submission or :doc:`dynamic form modification </form/dynamic_form_modification>`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should precise that clearing the errors makes the form valid. So clearErrors() should be called after testing if the form is valid or at least not rely on its state.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added a new sentence to clarify that. Thanks!


Because clearing the errors makes the form valid, ``clearErrors()`` should only be called after testing whether the form is valid.

Learn more
----------

Expand Down