From 6582966e2ed29e73ce39963e900fdf483178f5dd Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 30 Oct 2019 02:57:16 +0000 Subject: [PATCH] Docs: Document `$error`, `$interim_login`, and `$action` globals in `login_header()` and `login_footer()`. Props priyankabehera155, faisal03, mukesh27, SergeyBiryukov. Fixes #45777. git-svn-id: https://develop.svn.wordpress.org/trunk@46620 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-login.php | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/wp-login.php b/src/wp-login.php index 8f957f860f..ee0e212e2c 100644 --- a/src/wp-login.php +++ b/src/wp-login.php @@ -27,6 +27,12 @@ if ( force_ssl_admin() && ! is_ssl() ) { * * @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 `` element. * Default 'Log In'. * @param string $message Optional. Message to display in header. Default empty. @@ -269,6 +275,9 @@ function login_header( $title = 'Log In', $message = '', $wp_error = null ) { * * @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. */ function login_footer( $input_id = '' ) {