From e2b68a42530472774831927ea03cf51a7f54b81e Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sun, 1 Sep 2019 13:02:29 +0000 Subject: [PATCH] Docs: Improve documentation for `auth_redirect()`. Props atachibana. Fixes #47956. git-svn-id: https://develop.svn.wordpress.org/trunk@45924 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/pluggable.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php index 4fe656a965..270812ce42 100644 --- a/src/wp-includes/pluggable.php +++ b/src/wp-includes/pluggable.php @@ -1005,6 +1005,11 @@ if ( ! function_exists( 'auth_redirect' ) ) : /** * 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 */ function auth_redirect() {