Changeset 49078 for trunk/src/wp-includes/ms-functions.php

Timestamp:

09/30/2020 09:52:27 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Various docblock improvements related to user and site signup functionality.

See #50768

File:

• trunk/src/wp-includes/ms-functions.php (modified) (7 diffs)

trunk/src/wp-includes/ms-functions.php

@@ -1576 +1576 @@
 
 /**
- * Notify a user that their blog activation has been successful.
+ * Notifies the site administrator that their site activation was successful.
  *
  * Filter {@see 'wpmu_welcome_notification'} to disable or bypass.
@@ -1585 +1585 @@
  * @since MU (3.0.0)
  *
- * @param int    $blog_id  Blog ID.
+ * @param int    $blog_id  Site ID.
  * @param int    $user_id  User ID.
- * @param string $password User password.
+ * @param string $password User password, or "N/A" if the user account is not new.
  * @param string $title    Site title.
  * @param array  $meta     Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
- * @return bool
+ * @return bool Whether the email notification was sent.
  */
 function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) {
@@ -1596 +1596 @@
 
         /**
-         * Filters whether to bypass the welcome email after site activation.
+         * Filters whether to bypass the welcome email sent to the site administrator after site activation.
          *
          * Returning false disables the welcome email.
@@ -1602 +1602 @@
          * @since MU (3.0.0)
          *
-         * @param int|bool $blog_id  Blog ID.
-         * @param int      $user_id  User ID.
-         * @param string   $password User password.
+         * @param int|bool $blog_id  Site ID.
+         * @param int      $user_id  User ID of the site administrator.
+         * @param string   $password User password, or "N/A" if the user account is not new.
          * @param string   $title    Site title.
          * @param array    $meta     Signup meta data. By default, contains the requested privacy setting and lang_id.
@@ -1646 +1646 @@
 
         /**
-         * Filters the content of the welcome email after site activation.
+         * Filters the content of the welcome email sent to the site administrator after site activation.
          *
          * Content should be formatted for transmission via wp_mail().
@@ -1653 +1653 @@
          *
          * @param string $welcome_email Message body of the email.
-         * @param int    $blog_id       Blog ID.
-         * @param int    $user_id       User ID.
-         * @param string $password      User password.
+         * @param int    $blog_id       Site ID.
+         * @param int    $user_id       User ID of the site administrator.
+         * @param string $password      User password, or "N/A" if the user account is not new.
          * @param string $title         Site title.
          * @param array  $meta          Signup meta data. By default, contains the requested privacy setting and lang_id.
@@ -1679 +1679 @@
 
         /**
-         * Filters the subject of the welcome email after site activation.
+         * Filters the subject of the welcome email sent to the site administrator after site activation.
          *
          * @since MU (3.0.0)