Changeset 45924

Timestamp:

09/01/2019 01:02:29 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for auth_redirect().

Props atachibana.
Fixes #47956.

File:

• trunk/src/wp-includes/pluggable.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -1005 +1005 @@
     /**
      * Checks if a user is logged in, if not it redirects them to the login page.
+     *
+     * When this code is called from a page, it checks to see if the user viewing the page is logged in.
+     * If the user is not logged in, they are redirected to the login page. The user is redirected
+     * in such a way that, upon logging in, they will be sent directly to the page they were originally
+     * trying to access.
      *
      * @since 1.5.0