<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[43644] trunk/src/wp-login.php: Docs: Improve docblocks within `wp-login.php`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/43644">43644</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/43644","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-09-14 13:47:01 +0000 (Fri, 14 Sep 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve docblocks within `wp-login.php`.
Props birgire
See <a href="https://core.trac.wordpress.org/ticket/42505">#42505</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwploginphp">trunk/src/wp-login.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwploginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-login.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-login.php 2018-09-14 13:44:50 UTC (rev 43643)
+++ trunk/src/wp-login.php 2018-09-14 13:47:01 UTC (rev 43644)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,7 +11,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** Make sure that the WordPress bootstrap has run before continuing. */
</span><span class="cx" style="display: block; padding: 0 10px"> require( dirname( __FILE__ ) . '/wp-load.php' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Redirect to https login if forced to use SSL
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Redirect to HTTPS login if forced to use SSL.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( force_ssl_admin() && ! is_ssl() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_safe_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,6 +25,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Output the login page header.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.1.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Optional. WordPress login Page title to display in the `<title>` element.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'Log In'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $message Optional. Message to display in header. Default empty.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -89,7 +91,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Remove all stored post data on logging out.
</span><span class="cx" style="display: block; padding: 0 10px"> * This could be added by add_action('login_head'...) like wp_shake_js(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * but maybe better if it's not removable by plugins
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * but maybe better if it's not removable by plugins.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'loggedout' == $wp_error->get_error_code() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -202,7 +204,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> echo $message . "\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // In case a plugin uses $error rather than the $wp_errors object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // In case a plugin uses $error rather than the $wp_errors object.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $error ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_error->add( 'error', $error );
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $error );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -247,7 +249,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Outputs the footer for the login page.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $input_id Which input to auto-focus
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.1.0
+ *
+ * @param string $input_id Which input to auto-focus.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function login_footer( $input_id = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $interim_login;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -288,6 +292,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs the Javascript to handle the form shaking.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_shake_js() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -303,6 +309,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs the viewport meta tag.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_login_viewport_meta() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -314,6 +322,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Handles sending password retrieval email to user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.5.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|WP_Error True: when finish. WP_Error on error
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function retrieve_password() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -417,7 +427,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> //
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Main
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Main.
</ins><span class="cx" style="display: block; padding: 0 10px"> //
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'login';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -427,7 +437,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $action = 'resetpass';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// validate action so as to default to the login screen
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Validate action so as to default to the login screen.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $action, array( 'postpass', 'logout', 'lostpassword', 'retrievepassword', 'resetpass', 'rp', 'register', 'login', 'confirmaction' ), true ) && false === has_filter( 'login_form_' . $action ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $action = 'login';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -890,6 +900,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * After firing this action hook the page will redirect to wp-login a callback
</span><span class="cx" style="display: block; padding: 0 10px"> * redirects or exits first.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.6
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $request_id Request ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'user_request_action_confirmed', $request_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -908,7 +920,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'customize-base' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If the user wants ssl but the session is not ssl, force a secure cookie.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the user wants SSL but the session is not SSL, force a secure cookie.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $_POST['log'] ) && ! force_ssl_admin() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $user_name = sanitize_user( $_POST['log'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $user = get_user_by( 'login', $user_name );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -927,7 +939,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_REQUEST['redirect_to'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = $_REQUEST['redirect_to'];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Redirect to https if user wants ssl
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Redirect to HTTPS if user wants SSL.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $secure_cookie && false !== strpos( $redirect_to, 'wp-admin' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = preg_replace( '|^http://|', 'https://', $redirect_to );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1022,7 +1034,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $errors->add( 'expired', __( 'Your session has expired. Please log in to continue where you left off.' ), 'message' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Some parts of this script use the main login form to display a message
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Some parts of this script use the main login form to display a message.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_GET['loggedout'] ) && true == $_GET['loggedout'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $errors->add( 'loggedout', __( 'You are now logged out.' ), 'message' );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $_GET['registration'] ) && 'disabled' == $_GET['registration'] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1172,4 +1184,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-} // end action switch
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+} // End action switch.
</ins></span></pre>
</div>
</div>
</body>
</html>