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

Timestamp:

01/28/2016 03:50:26 AM (9 years ago)

Author:

ericlewis

Message:

Networks and sites: Replace "blog" usage with "site" in docs.

Multisite functions use the term "blog" to refer to what we now call a "site," e.g. get_current_blog_id(). These functions are here to stay because of our commitment to backwards compatibility. What we can do is set the documentation straight.

See #35417.

File:

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

trunk/src/wp-signup.php

@@ -259 +259 @@
  *
  * @param string $blogname The new site name
- * @param string $blog_title The new blog title
+ * @param string $blog_title The new site title.
  * @param array $errors
  */
@@ -336 +336 @@
 
 /**
- * Validate a new blog signup
- *
- * @since MU
- *
- * @return null|bool True if blog signup was validated, false if error.
+ * Validate a new site signup.
+ *
+ * @since MU
+ *
+ * @return null|bool True if site signup was validated, false if error.
  *                   The function halts all execution if the user is not logged in.
  */
@@ -421 +421 @@
 
 /**
- * Confirm a new site signup
+ * Confirm a new site signup.
  *
  * @since MU
  * @since 4.4.0 Added the `$blog_id` parameter.
  *
- * @param string $domain The domain URL
- * @param string $path The site root path
- * @param string $blog_title The blog title
- * @param string $user_name The username
- * @param string $user_email The user's email address
- * @param array  $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup()
- * @param int    $blog_id The blog ID
+ * @param string $domain     The domain URL.
+ * @param string $path       The site root path.
+ * @param string $blog_title The site title.
+ * @param string $user_name  The username.
+ * @param string $user_email The user's email address.
+ * @param array  $meta       Any additional meta from the 'add_signup_meta' filter in validate_blog_signup().
+ * @param int    $blog_id    The site ID.
  */
 function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = array(), $blog_id = 0 ) {