minor #9916 [Form] Ability to clear form errors (colinodell, javiereguiluz)

javiereguiluz · javiereguiluz · commit 53b6a51083bd · 2018-06-25T15:37:40.000+02:00
This PR was merged into the master branch. Discussion ---------- [Form] Ability to clear form errors Documenting the new feature proposed in symfony/symfony#27580 Commits ------- f07f536 Wrap long lines and add the versionadded directive 7a4465d Clarify that clearing errors makes the form valid d4143f1 [Form] Ability to clear form errors
diff --git a/components/form.rst b/components/form.rst
@@ -744,6 +744,21 @@ 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
+~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 4.2
+    The ``clearErrors()`` method was introduced in Symfony 4.2.
+
+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>`).
+
+Because clearing the errors makes the form valid, ``clearErrors()`` should only
+be called after testing whether the form is valid.
+
 Learn more
 ----------
 
