Changeset 37547 for trunk/src/wp-signup.php

Timestamp:

05/24/2016 04:15:57 AM (10 years ago)

Author:

jeremyfelt

Message:

Multisite: Clean up WP_Error documentation and handling in wp-signup.php

Fixes #36927.

File:

• trunk/src/wp-signup.php (modified) (10 diffs)

trunk/src/wp-signup.php

@@ -92 +92 @@
  * @since MU
  *
- * @param string $blogname The new site name
- * @param string $blog_title The new site title
- * @param array $errors
+ * @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.
  */
 function show_blog_form( $blogname = '', $blog_title = '', $errors = '' ) {
+        if ( ! is_wp_error( $errors ) ) {
+                $errors = new WP_Error();
+        }
+
         $current_site = get_current_site();
         // Blog name
@@ -184 +188 @@
          * @since 3.0.0
          *
-         * @param array $errors An array possibly containing 'blogname' or 'blog_title' errors.
+         * @param WP_Error $errors A WP_Error object possibly containing 'blogname' or 'blog_title' errors.
          */
         do_action( 'signup_blogform', $errors );
@@ -209 +213 @@
  * @since MU
  *
- * @param string $user_name The entered username
- * @param string $user_email The entered email address
- * @param array $errors
+ * @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.
  */
 function show_user_form($user_name = '', $user_email = '', $errors = '') {
+        if ( ! is_wp_error( $errors ) ) {
+                $errors = new WP_Error();
+        }
+
         // User name
         echo '<label for="user_name">' . __('Username:') . '</label>';
@@ -237 +245 @@
          * @since 3.0.0
          *
-         * @param array $errors An array possibly containing 'user_name' or 'user_email' errors.
+         * @param WP_Error $errors A WP_Error object containing containing 'user_name' or 'user_email' errors.
          */
         do_action( 'signup_extra_fields', $errors );
@@ -258 +266 @@
  * @since MU
  *
- * @param string $blogname The new site name
- * @param string $blog_title The new site title.
- * @param array $errors
+ * @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.
  */
 function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
@@ -283 +291 @@
          *     An array of default site sign-up variables.
          *
-         *     @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.
+         *     @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.
          * }
          */
@@ -478 +486 @@
  * @since MU
  *
- * @param string $user_name The username
- * @param string $user_email The user's email
- * @param array $errors
+ * @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.
  */
 function signup_user( $user_name = '', $user_email = '', $errors = '' ) {
@@ -504 +512 @@
          *     An array of default user variables.
          *
-         *     @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.
+         *     @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.
          * }
          */
@@ -600 +608 @@
  * @since MU
  *
- * @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
+ * @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.
  */
 function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_title = '', $errors = '') {
@@ -626 +634 @@
          *     An array of default site creation variables.
          *
-         *     @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.
+         *     @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.
          * }
          */