Changeset 36417

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.

Location:

trunk/src

Files:

• wp-includes/author-template.php (modified) (1 diff)
• wp-includes/class-wp-user-query.php (modified) (1 diff)
• wp-includes/class-wp-user.php (modified) (3 diffs)
• wp-includes/functions.php (modified) (2 diffs)
• wp-signup.php (modified) (3 diffs)

trunk/src/wp-includes/author-template.php

@@ -327 +327 @@
 
 /**
- * List all the authors of the blog, with several options available.
+ * List all the authors of the site, with several options available.
  *
  * @link https://codex.wordpress.org/Template_Tags/wp_list_authors

trunk/src/wp-includes/class-wp-user-query.php

@@ -141 +141 @@
      *     Optional. Array or string of Query parameters.
      *
-     *     @type int          $blog_id             The site ID. Default is the global blog id.
+     *     @type int          $blog_id             The site ID. Default is the current site.
      *     @type string|array $role                An array or a comma-separated list of role names that users must match
      *                                             to be included in results. Note that this is an inclusive list: users

trunk/src/wp-includes/class-wp-user.php

@@ -114 +114 @@
      * @param int|string|stdClass|WP_User $id User's ID, a WP_User object, or a user object from the DB.
      * @param string $name Optional. User's username
-     * @param int $blog_id Optional Blog ID, defaults to current blog.
+     * @param int $blog_id Optional Site ID, defaults to current site.
      */
     public function __construct( $id = 0, $name = '', $blog_id = '' ) {
@@ -769 +769 @@
 
     /**
-     * Set the blog to operate on. Defaults to the current blog.
+     * Set the site to operate on. Defaults to the current site.
      *
      * @since 3.0.0
@@ -775 +775 @@
      * @global wpdb $wpdb WordPress database abstraction object.
      *
-     * @param int $blog_id Optional Blog ID, defaults to current blog.
+     * @param int $blog_id Optional. Site ID, defaults to current site.
      */
     public function for_blog( $blog_id = '' ) {

trunk/src/wp-includes/functions.php

@@ -1335 +1335 @@
 
 /**
- * Test whether blog is already installed.
+ * Test whether WordPress is already installed.
  *
  * The cache will be checked first. If you have a cache plugin, which saves
@@ -1347 +1347 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @return bool Whether the blog is already installed.
+ * @return bool Whether the site is already installed.
  */
 function is_blog_installed() {

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 ) {