mirror of https://github.com/django/django.git
Fixed #12113 -- Clarified is_active documentation. Thanks, ejucovy and isagalaev
git-svn-id: http://code.djangoproject.com/svn/django/trunk@12193 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
31eb0fbe3d
commit
06645cbda7
|
@ -97,14 +97,20 @@ Fields
|
||||||
.. attribute:: models.User.is_active
|
.. attribute:: models.User.is_active
|
||||||
|
|
||||||
Boolean. Designates whether this user account should be considered
|
Boolean. Designates whether this user account should be considered
|
||||||
active. Set this flag to ``False`` instead of deleting accounts.
|
active. We recommend that you set this flag to ``False`` instead of
|
||||||
|
deleting accounts; that way, if your applications have any foreign keys
|
||||||
|
to users, the foreign keys won't break.
|
||||||
|
|
||||||
This doesn't control whether or not the user can log in. Nothing in the
|
This doesn't necessarily control whether or not the user can log in.
|
||||||
authentication path checks the ``is_active`` flag, so if you want to
|
Authentication backends aren't required to check for the ``is_active``
|
||||||
reject a login based on ``is_active`` being ``False``, it is up to you
|
flag, so if you want to reject a login based on ``is_active`` being
|
||||||
to check that in your own login view. However, permission checking
|
``False``, it's up to you to check that in your own login view.
|
||||||
using the methods like :meth:`~models.User.has_perm` does check this
|
However, the :class:`~django.contrib.auth.forms.AuthenticationForm`
|
||||||
flag and will always return ``False`` for inactive users.
|
used by the :func:`~django.contrib.auth.views.login` view *does*
|
||||||
|
perform this check, as do the permission-checking methods such as
|
||||||
|
:meth:`~models.User.has_perm` and the authentication in the Django
|
||||||
|
admin. All of those functions/methods will return ``False`` for
|
||||||
|
inactive users.
|
||||||
|
|
||||||
.. attribute:: models.User.is_superuser
|
.. attribute:: models.User.is_superuser
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue