sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve documentation for auth_redirect().

Browse Source 
Props atachibana.
Fixes #47956.

git-svn-id: https://develop.svn.wordpress.org/trunk@45924 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2019-09-01 13:02:29 +00:00
parent 27c877e2b9
commit e2b68a4253
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/wp-includes/pluggable.php
View File

@ -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. * 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 * @since 1.5.0
*/ */
function auth_redirect() { function auth_redirect() {