<!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>[37547] trunk/src/wp-signup.php: Multisite: Clean up `WP_Error` documentation and handling in `wp-signup.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 { 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/37547">37547</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/37547","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jeremyfelt</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-24 04:15:57 +0000 (Tue, 24 May 2016)</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'>Multisite: Clean up `WP_Error` documentation and handling in `wp-signup.php`

Fixes <a href="https://core.trac.wordpress.org/ticket/36927">#36927</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpsignupphp">trunk/src/wp-signup.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpsignupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-signup.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-signup.php   2016-05-24 03:42:36 UTC (rev 37546)
+++ trunk/src/wp-signup.php     2016-05-24 04:15:57 UTC (rev 37547)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,11 +91,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * @since MU
</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 $blogname The new site name
- * @param string $blog_title The new site title
- * @param array $errors
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string          $blogname   The new site name.
+ * @param string          $blog_title The new site title.
+ * @param WP_Error|string $errors     A WP_Error object containing existing errors. Defaults to empty string.
</ins><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> function show_blog_form( $blogname = '', $blog_title = '', $errors = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        if ( ! is_wp_error( $errors ) ) {
+               $errors = new WP_Error();
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         $current_site = get_current_site();
</span><span class="cx" style="display: block; padding: 0 10px">        // Blog name
</span><span class="cx" style="display: block; padding: 0 10px">        if ( !is_subdomain_install() )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -183,7 +187,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 3.0.0
</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 array $errors An array possibly containing 'blogname' or 'blog_title' errors.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param WP_Error $errors A WP_Error object possibly containing 'blogname' or 'blog_title' errors.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><span class="cx" style="display: block; padding: 0 10px">        do_action( 'signup_blogform', $errors );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,11 +212,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * @since MU
</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 $user_name The entered username
- * @param string $user_email The entered email address
- * @param array $errors
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string          $user_name  The entered username.
+ * @param string          $user_email The entered email address.
+ * @param WP_Error|string $errors     A WP_Error object containing existing errors. Defaults to empty string.
</ins><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> function show_user_form($user_name = '', $user_email = '', $errors = '') {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        if ( ! is_wp_error( $errors ) ) {
+               $errors = new WP_Error();
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         // User name
</span><span class="cx" style="display: block; padding: 0 10px">        echo '<label for="user_name">' . __('Username:') . '</label>';
</span><span class="cx" style="display: block; padding: 0 10px">        if ( $errmsg = $errors->get_error_message('user_name') ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -236,7 +244,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 3.0.0
</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 array $errors An array possibly containing 'user_name' or 'user_email' errors.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param WP_Error $errors A WP_Error object containing containing 'user_name' or 'user_email' errors.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><span class="cx" style="display: block; padding: 0 10px">        do_action( 'signup_extra_fields', $errors );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -257,9 +265,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * @since MU
</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 $blogname The new site name
- * @param string $blog_title The new site title.
- * @param array $errors
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string          $blogname   The new site name
+ * @param string          $blog_title The new site title.
+ * @param WP_Error|string $errors     A WP_Error object containing existing errors. Defaults to empty string.
</ins><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px">        $current_user = wp_get_current_user();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,9 +290,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @param array $signup_defaults {
</span><span class="cx" style="display: block; padding: 0 10px">         *     An array of default site sign-up variables.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *     @type string $blogname   The site blogname.
-        *     @type string $blog_title The site title.
-        *     @type array  $errors     An array possibly containing 'blogname' or 'blog_title' errors.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *     @type string   $blogname   The site blogname.
+        *     @type string   $blog_title The site title.
+        *     @type WP_Error $errors     A WP_Error object possibly containing 'blogname' or 'blog_title' errors.
</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">        $filtered_results = apply_filters( 'signup_another_blog_init', $signup_defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -477,9 +485,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * @since MU
</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 $user_name The username
- * @param string $user_email The user's email
- * @param array $errors
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string          $user_name  The username.
+ * @param string          $user_email The user's email.
+ * @param WP_Error|string $errors     A WP_Error object containing existing errors. Defaults to empty string.
</ins><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> function signup_user( $user_name = '', $user_email = '', $errors = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px">        global $active_signup;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -503,9 +511,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @param array $signup_user_defaults {
</span><span class="cx" style="display: block; padding: 0 10px">         *     An array of default user variables.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *     @type string $user_name  The user username.
-        *     @type string $user_email The user email address.
-        *     @type array  $errors     An array of possible errors relevant to the sign-up user.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *     @type string   $user_name  The user username.
+        *     @type string   $user_email The user email address.
+        *     @type WP_Error $errors     A WP_Error object with possible errors relevant to the sign-up user.
</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">        $filtered_results = apply_filters( 'signup_user_init', $signup_user_defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -599,11 +607,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * @since MU
</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 $user_name The username
- * @param string $user_email The user's email address
- * @param string $blogname The site name
- * @param string $blog_title The site title
- * @param array $errors
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string          $user_name  The username.
+ * @param string          $user_email The user's email address.
+ * @param string          $blogname   The site name.
+ * @param string          $blog_title The site title.
+ * @param WP_Error|string $errors     A WP_Error object containing existing errors. Defaults to empty string.
</ins><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_title = '', $errors = '') {
</span><span class="cx" style="display: block; padding: 0 10px">        if ( !is_wp_error($errors) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -625,11 +633,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @param array $signup_blog_defaults {
</span><span class="cx" style="display: block; padding: 0 10px">         *     An array of default site creation variables.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *     @type string $user_name  The user username.
-        *     @type string $user_email The user email address.
-        *     @type string $blogname   The blogname.
-        *     @type string $blog_title The title of the site.
-        *     @type array  $errors     An array of possible errors relevant to new site creation variables.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *     @type string   $user_name  The user username.
+        *     @type string   $user_email The user email address.
+        *     @type string   $blogname   The blogname.
+        *     @type string   $blog_title The title of the site.
+        *     @type WP_Error $errors     A WP_Error object with possible errors relevant to new site creation variables.
</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">        $filtered_results = apply_filters( 'signup_blog_init', $signup_blog_defaults );
</span></span></pre>
</div>
</div>

</body>
</html>