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
This commit is contained in:
Sergey Biryukov 2019-10-30 02:57:16 +00:00
parent 7d2bb9f8c6
commit 6582966e2e

View File

@ -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 `<title>` 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 = '' ) {