PHPDoc correction for auth_redirect() in wp-includes/pluggable.php

[atachibana]

Enhanced missing information of Codex for auth_redirect() in wp-includes/pluggable.php

• Description

 	/**
 	 * 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
 	 */

Codex: ​https://codex.wordpress.org/Function_Reference/auth_redirect
Code Reference: ​https://developer.wordpress.org/reference/functions/auth_redirect/

This is the action of inline docs and Codex migration initiatives.

[SergeyBiryukov]

In 45924:

Docs: Improve documentation for auth_redirect().

Props atachibana.
Fixes #47956.