Changeset 36416 for trunk/src/wp-admin/includes/ms.php

Timestamp:

01/28/2016 03:34:02 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-admin/includes/ms.php (modified) (9 diffs)

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

@@ -49 +49 @@
 
 /**
- * Delete a blog.
+ * Delete a site.
  *
  * @since 3.0.0
@@ -55 +55 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param int  $blog_id Blog ID.
- * @param bool $drop    True if blog's table should be dropped. Default is false.
+ * @param int  $blog_id Site ID.
+ * @param bool $drop    True if site's database tables should be dropped. Default is false.
  */
 function wpmu_delete_blog( $blog_id, $drop = false ) {
@@ -69 +69 @@
     $blog = get_blog_details( $blog_id );
     /**
-     * Fires before a blog is deleted.
+     * Fires before a site is deleted.
      *
      * @since MU
      *
-     * @param int  $blog_id The blog ID.
-     * @param bool $drop    True if blog's table should be dropped. Default is false.
+     * @param int  $blog_id The site ID.
+     * @param bool $drop    True if site's table should be dropped. Default is false.
      */
     do_action( 'delete_blog', $blog_id, $drop );
@@ -113 +113 @@
         $tables = $wpdb->tables( 'blog' );
         /**
-         * Filter the tables to drop when the blog is deleted.
+         * Filter the tables to drop when the site is deleted.
          *
          * @since MU
          *
-         * @param array $tables  The blog tables to be dropped.
-         * @param int   $blog_id The ID of the blog to drop tables for.
+         * @param array $tables  The site tables to be dropped.
+         * @param int   $blog_id The ID of the site to drop tables for.
          */
         $drop_tables = apply_filters( 'wpmu_drop_tables', $tables, $blog_id );
@@ -129 +129 @@
 
         /**
-         * Filter the upload base directory to delete when the blog is deleted.
+         * Filter the upload base directory to delete when the site is deleted.
          *
          * @since MU
          *
          * @param string $uploads['basedir'] Uploads path without subdirectory. @see wp_upload_dir()
-         * @param int    $blog_id            The blog ID.
+         * @param int    $blog_id            The site ID.
          */
         $dir = apply_filters( 'wpmu_delete_blog_upload_dir', $uploads['basedir'], $blog_id );
@@ -411 +411 @@
 
 /**
- * Check whether a blog has used its allotted upload space.
+ * Check whether a site has used its allotted upload space.
  *
  * @since MU
@@ -438 +438 @@
 
 /**
- * Displays the amount of disk space used by the current blog. Not used in core.
+ * Displays the amount of disk space used by the current site. Not used in core.
  *
  * @since MU
@@ -463 +463 @@
 
 /**
- * Get the remaining upload space for this blog.
+ * Get the remaining upload space for this site.
  *
  * @since MU
@@ -479 +479 @@
 
 /**
- * Displays the edit blog upload space setting form on the Edit Blog screen.
- *
- * @since 3.0.0
- *
- * @param int $id The ID of the blog to display the setting for.
+ * Displays the site upload space quota setting form on the Edit Site Settings screen.
+ *
+ * @since 3.0.0
+ *
+ * @param int $id The ID of the site to display the setting for.
  */
 function upload_space_setting( $id ) {