diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index 008170d341..34f8adbaec 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -250,8 +250,8 @@ precedence:: Url: Comment: -Checking if form data has changed ---------------------------------- +Checking which form data has changed +------------------------------------ .. method:: Form.has_changed() @@ -277,6 +277,16 @@ from what was provided in :attr:`~Form.initial` or ``False`` otherwise. The result is computed by calling :meth:`Field.has_changed` for each field in the form. +.. attribute:: Form.changed_data + +The ``changed_data`` attribute returns a list of the names of the fields whose +values in the form's bound data (usually ``request.POST``) differ from what was +provided in :attr:`~Form.initial`. It returns an empty list if no data differs. + + >>> f = ContactForm(request.POST, initial=data) + >>> if f.has_changed(): + ... print("The following fields changed: %s" % ", ".join(f.changed_data)) + Accessing the fields from the form ----------------------------------