Changeset 51699

Timestamp:

08/31/2021 12:23:46 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation in wp-signup.php.

• Document the $active_signup global in signup_user().
• Update some DocBlocks per the documentation standards.
• Expand some function descriptions for clarity.

Follow-up to [37535], [37536], [41200], [43326], [49078], [50828].

Props mt8.biz, sabernhardt, audrasjb, westonruter, jayupadhyay01, mukesh27, SergeyBiryukov.
Fixes #41566.

File:

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

trunk/src/wp-signup.php

@@ -16 +16 @@
 
 /**
- * Prints signup_header via wp_head
+ * Prints signup_header via wp_head.
  *
  * @since MU (3.0.0)
@@ -51 +51 @@
 
 /**
- * Prints styles for front-end Multisite signup pages
+ * Prints styles for front-end Multisite signup pages.
  *
  * @since MU (3.0.0)
@@ -90 +90 @@
 <?php
 /**
- * Generates and displays the Signup and Create Site forms
+ * Generates and displays the Signup and Create Site forms.
  *
  * @since MU (3.0.0)
@@ -225 +225 @@
 
 /**
- * Validate the new site signup
+ * Validates the new site signup.
  *
  * @since MU (3.0.0)
@@ -289 +289 @@
 
 /**
- * Validate user signup name and email
+ * Validates user signup name and email.
  *
  * @since MU (3.0.0)
@@ -301 +301 @@
 
 /**
- * Allow returning users to sign up for another site
+ * Shows a form for returning users to sign up for another site.
  *
  * @since MU (3.0.0)
@@ -395 +395 @@
 
 /**
- * Validate a new site signup for an existing user.
- *
- * @global string          $blogname   The new site's subdomain or directory name.
- * @global string          $blog_title The new site's title.
- * @global WP_Error        $errors     Existing errors in the global scope.
- * @global string          $domain     The new site's domain.
- * @global string          $path       The new site's path.
- *
- * @since MU (3.0.0)
- *
- * @return null|bool True if site signup was validated, false if error.
+ * Validates a new site signup for an existing user.
+ *
+ * @since MU (3.0.0)
+ *
+ * @global string   $blogname   The new site's subdomain or directory name.
+ * @global string   $blog_title The new site's title.
+ * @global WP_Error $errors     Existing errors in the global scope.
+ * @global string   $domain     The new site's domain.
+ * @global string   $path       The new site's path.
+ *
+ * @return null|bool True if site signup was validated, false on error.
  *                   The function halts all execution if the user is not logged in.
  */
@@ -487 +487 @@
 
 /**
- * Confirm a new site signup.
+ * Shows a message confirming that the new site has been created.
  *
  * @since MU (3.0.0)
@@ -554 +554 @@
  * @since MU (3.0.0)
  *
+ * @global string $active_signup String that returns registration type. The value can be
+ *                               'all', 'none', 'blog', or 'user'.
+ *
  * @param string          $user_name  The username.
  * @param string          $user_email The user's email.
@@ -627 +630 @@
 
 /**
- * Validate the new user signup
- *
- * @since MU (3.0.0)
- *
- * @return bool True if new user signup was validated, false if error
+ * Validates the new user signup.
+ *
+ * @since MU (3.0.0)
+ *
+ * @return bool True if new user signup was validated, false on error.
  */
 function validate_user_signup() {
@@ -657 +660 @@
 
 /**
- * New user signup confirmation
- *
- * @since MU (3.0.0)
- *
- * @param string $user_name The username
- * @param string $user_email The user's email address
+ * Shows a message confirming that the new user has been registered and is awaiting activation.
+ *
+ * @since MU (3.0.0)
+ *
+ * @param string $user_name  The username.
+ * @param string $user_email The user's email address.
  */
 function confirm_user_signup( $user_name, $user_email ) {
@@ -751 +754 @@
 
 /**
- * Validate new site signup
- *
- * @since MU (3.0.0)
- *
- * @return bool True if the site signup was validated, false if error
+ * Validates new site signup.
+ *
+ * @since MU (3.0.0)
+ *
+ * @return bool True if the site signup was validated, false on error.
  */
 function validate_blog_signup() {