WordPress.org

Make WordPress Core

Opened 13 months ago

Closed 13 months ago

#47956 closed defect (bug) (fixed)

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

Reported by: atachibana Owned by: SergeyBiryukov
Milestone: 5.3 Priority: normal
Severity: minor Version:
Component: Users Keywords: has-patch
Focuses: docs Cc:

Description

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.

Attachments (1)

47956.diff​ (654 bytes) - added by atachibana 13 months ago.

Download all attachments as: .zip

Change History (3)

@atachibana
13 months ago

#1 @SergeyBiryukov
13 months ago

  • Component changed from General to Users
  • Milestone changed from Awaiting Review to 5.3
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#2 @SergeyBiryukov
13 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 45924:

Docs: Improve documentation for auth_redirect().

Props atachibana.
Fixes #47956.

Note: See TracTickets for help on using tickets.