Changeset 46620

Timestamp:

10/30/2019 02:57:16 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document $error, $interim_login, and $action globals in login_header() and login_footer().

Props priyankabehera155, faisal03, mukesh27, SergeyBiryukov.
Fixes #45777.

File:

• trunk/src/wp-login.php (modified) (2 diffs)

trunk/src/wp-login.php

@@ -27 +27 @@
  *
  * @since 2.1.0
+ *
+ * @global string      $error         Login error message set by deprecated pluggable wp_login() function
+ *                                    or plugins replacing it.
+ * @global bool|string $interim_login Whether interim login modal is being displayed. String 'success'
+ *                                    upon successful login.
+ * @global string      $action        The action that brought the visitor to the login page.
  *
  * @param string   $title    Optional. WordPress login Page title to display in the `<title>` element.
@@ -269 +275 @@
  *
  * @since 3.1.0
+ *
+ * @global bool|string $interim_login Whether interim login modal is being displayed. String 'success'
+ *                                    upon successful login.
  *
  * @param string $input_id Which input to auto-focus.