Ticket #40364: 40364.diff

src/wp-admin/includes/ms.php

@@ -53 +53 @@
  * Delete a site.
  *
  * @since 3.0.0
+ * @since 4.9.0 Now uses `wp_delete_site()` to delete the site row from the database.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
@@ -127 +128 @@
                         $wpdb->query( "DROP TABLE IF EXISTS `$table`" );
                 }
 
-                $wpdb->delete( $wpdb->blogs, array( 'blog_id' => $blog_id ) );
+                wp_delete_site( $blog );
 
                 /**
                  * Filters the upload base directory to delete when the site is deleted.
@@ -169 +170 @@
                         if ( $dir != $top_dir)
                         @rmdir( $dir );
                 }
-
-                clean_blog_cache( $blog );
         }
 
         /**

src/wp-includes/ms-blogs.php

@@ -295 +295 @@
  * Update the details for a blog. Updates the blogs table for a given blog id.
  *
  * @since MU
+ * @since 4.9.0 Now wraps `wp_update_site()`.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
@@ -311 +312 @@
         if ( is_object($details) )
                 $details = get_object_vars($details);
 
-        $current_details = get_site( $blog_id );
-        if ( empty($current_details) )
-                return false;
-
-        $current_details = get_object_vars($current_details);
-
-        $details = array_merge($current_details, $details);
-        $details['last_updated'] = current_time('mysql', true);
-
-        $update_details = array();
-        $fields = array( 'site_id', 'domain', 'path', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id');
-        foreach ( array_intersect( array_keys( $details ), $fields ) as $field ) {
-                if ( 'path' === $field ) {
-                        $details[ $field ] = trailingslashit( '/' . trim( $details[ $field ], '/' ) );
-                }
+        $site = get_site( $blog_id );
+        foreach ( $details as $field => $value ) {
+                $site->$field = $value;
+        }
 
-                $update_details[ $field ] = $details[ $field ];
+        $site = wp_update_site( $site );
+        if ( is_wp_error( $site ) ) {
+                return false;
         }
 
-        $result = $wpdb->update( $wpdb->blogs, $update_details, array('blog_id' => $blog_id) );
+        //TODO: Do we need to run the 'refresh_blog_details' hook here for BC?
 
-        if ( false === $result )
-                return false;
+        return true;
+}
+
+/**
+ * Runs hooks when one or more site status fields have been updated.
+ *
+ * @since 4.9.0
+ *
+ * @param WP_Site $existing_site Site object prior to the update.
+ * @param WP_Site $updated_site  Site object after the update.
+ */
+function maybe_transition_site_statuses( $existing_site, $updated_site ) {
+        $site_id = $updated_site->id;
 
         // If spam status changed, issue actions.
-        if ( $details['spam'] != $current_details['spam'] ) {
-                if ( $details['spam'] == 1 ) {
+        if ( $updated_site->spam != $existing_site->spam ) {
+                if ( $updated_site->spam == 1 ) {
                         /**
-                         * Fires when the 'spam' status is added to a blog.
+                         * Fires when the 'spam' status is added to a site.
                          *
                          * @since MU
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'make_spam_blog', $blog_id );
+                        do_action( 'make_spam_blog', $site_id );
                 } else {
                         /**
-                         * Fires when the 'spam' status is removed from a blog.
+                         * Fires when the 'spam' status is removed from a site.
                          *
                          * @since MU
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'make_ham_blog', $blog_id );
+                        do_action( 'make_ham_blog', $site_id );
                 }
         }
 
         // If mature status changed, issue actions.
-        if ( $details['mature'] != $current_details['mature'] ) {
-                if ( $details['mature'] == 1 ) {
+        if ( $updated_site->mature != $existing_site->mature ) {
+                if ( $updated_site->mature == 1 ) {
                         /**
-                         * Fires when the 'mature' status is added to a blog.
+                         * Fires when the 'mature' status is added to a site.
                          *
                          * @since 3.1.0
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'mature_blog', $blog_id );
+                        do_action( 'mature_blog', $site_id );
                 } else {
                         /**
-                         * Fires when the 'mature' status is removed from a blog.
+                         * Fires when the 'mature' status is removed from a site.
                          *
                          * @since 3.1.0
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'unmature_blog', $blog_id );
+                        do_action( 'unmature_blog', $site_id );
                 }
         }
 
         // If archived status changed, issue actions.
-        if ( $details['archived'] != $current_details['archived'] ) {
-                if ( $details['archived'] == 1 ) {
+        if ( $updated_site->archived != $existing_site->archived ) {
+                if ( $updated_site->archived == 1 ) {
                         /**
-                         * Fires when the 'archived' status is added to a blog.
+                         * Fires when the 'archived' status is added to a site.
                          *
                          * @since MU
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'archive_blog', $blog_id );
+                        do_action( 'archive_blog', $site_id );
                 } else {
                         /**
-                         * Fires when the 'archived' status is removed from a blog.
+                         * Fires when the 'archived' status is removed from a site.
                          *
                          * @since MU
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'unarchive_blog', $blog_id );
+                        do_action( 'unarchive_blog', $site_id );
                 }
         }
 
         // If deleted status changed, issue actions.
-        if ( $details['deleted'] != $current_details['deleted'] ) {
-                if ( $details['deleted'] == 1 ) {
+        if ( $updated_site->deleted != $existing_site->deleted ) {
+                if ( $updated_site->deleted == 1 ) {
                         /**
-                         * Fires when the 'deleted' status is added to a blog.
+                         * Fires when the 'deleted' status is added to a site.
                          *
                          * @since 3.5.0
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'make_delete_blog', $blog_id );
+                        do_action( 'make_delete_blog', $site_id );
                 } else {
                         /**
-                         * Fires when the 'deleted' status is removed from a blog.
+                         * Fires when the 'deleted' status is removed from a site.
                          *
                          * @since 3.5.0
                          *
-                         * @param int $blog_id Blog ID.
+                         * @param int $site_id Site ID.
                          */
-                        do_action( 'make_undelete_blog', $blog_id );
+                        do_action( 'make_undelete_blog', $site_id );
                 }
         }
 
-        if ( isset( $details['public'] ) ) {
-                switch_to_blog( $blog_id );
-                update_option( 'blog_public', $details['public'] );
+        //TODO: This should not be in here. It is an action in single-site context and database tables may not exist.
+        if ( $updated_site->public != $existing_site->public ) {
+                switch_to_blog( $site_id );
+                update_option( 'blog_public', $updated_site->public );
                 restore_current_blog();
         }
-
-        refresh_blog_details($blog_id);
-
-        return true;
 }
 
 /**
@@ -498 +498 @@
 }
 
 /**
+ * Inserts a new site into the database.
+ *
+ * @since 4.9.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param WP_Site $site Site object to insert its data. Its $id property must not be
+ *                      set prior to inserting the site.
+ * @return WP_Site|WP_Error Modified site object with $id property set on success, or
+ *                          error object on failure.
+ */
+function wp_insert_site( $site ) {
+        global $wpdb;
+
+        if ( ! empty( $site->id ) ) {
+                return new WP_Error( 'site_already_exist', __( 'Cannot create existing site.' ) );
+        }
+
+        if ( empty( $site->domain ) ) {
+                return new WP_Error( 'site_empty_domain', __( 'Site domain must not be empty.' ) );
+        }
+
+        $site->path = trailingslashit( $site->path );
+
+        if ( empty( $site->network_id ) ) {
+                $site->network_id = get_current_network_id();
+        }
+
+        $site->registered = current_time( 'mysql' );
+        $site->last_updated = $site->registered;
+
+        $args = $site->to_array();
+
+        $fields = array( 'domain', 'path', 'site_id', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
+        $args = array_intersect_key( $args, array_flip( $fields ) );
+
+        $result = $wpdb->insert( $wpdb->blogs, $args );
+        if ( ! $result ) {
+                return new WP_Error( 'could_not_insert_site', __( 'Site could not be inserted into the database.' ) );
+        }
+
+        $site->id = $wpdb->insert_id;
+
+        clean_blog_cache( $site );
+
+        //TODO: Pass $site->network_id to the function after #40384 is done.
+        wp_maybe_update_network_site_counts();
+
+        return $site;
+}
+
+/**
+ * Updates an existing site in the database.
+ *
+ * @since 4.9.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param WP_Site $site Site object to update its data.
+ * @return WP_Site|WP_Error Modified site object on success, or
+ *                          error object on failure.
+ */
+function wp_update_site( $site ) {
+        global $wpdb;
+
+        $existing_site = ! empty( $site->id ) ? get_site( $site->id ) : null;
+        if ( ! $existing_site ) {
+                return new WP_Error( 'site_not_exist', __( 'Cannot update not-existing site.' ) );
+        }
+
+        if ( empty( $site->domain ) ) {
+                return new WP_Error( 'site_empty_domain', __( 'Site domain must not be empty.' ) );
+        }
+
+        $site->path = trailingslashit( $site->path );
+
+        if ( empty( $site->network_id ) ) {
+                $site->network_id = get_current_network_id();
+        }
+
+        $site->last_updated = current_time( 'mysql' );
+
+        $args = $site->to_array();
+
+        $fields = array( 'domain', 'path', 'site_id', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
+        $args = array_intersect_key( $args, array_flip( $fields ) );
+
+        $result = $wpdb->update( $wpdb->blogs, $args, array( 'blog_id' => $site->id ) );
+        if ( ! $result ) {
+                return new WP_Error( 'could_not_update_site', __( 'Site could not be updated in the database.' ) );
+        }
+
+        maybe_transition_site_statuses( $existing_site, $site );
+
+        clean_blog_cache( $site );
+
+        return $site;
+}
+
+/**
+ * Deletes an existing site from the database.
+ *
+ * @since 4.9.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param WP_Site $site Site object to delete its data.
+ * @return WP_Site|WP_Error Modified site object with $id property removed on success, or
+ *                          error object on failure.
+ */
+function wp_delete_site( $site ) {
+        global $wpdb;
+
+        $existing_site = ! empty( $site->id ) ? get_site( $site->id ) : null;
+        if ( ! $existing_site ) {
+                return new WP_Error( 'site_not_exist', __( 'Cannot update non-existing site.' ) );
+        }
+
+        $result = $wpdb->delete( $wpdb->blogs, array( 'blog_id' => $site->id ) );
+        if ( ! $result ) {
+                return new WP_Error( 'could_not_delete_site', __( 'Site could not be deleted from the database.' ) );
+        }
+
+        clean_blog_cache( $site );
+
+        //TODO: Pass $site->network_id to the function after #40384 is done.
+        wp_maybe_update_network_site_counts();
+
+        $site->id = 0;
+
+        return $site;
+}
+
+/**
  * Retrieves site data given a site ID or site object.
  *
  * Site data will be cached and returned after being passed through a filter.

src/wp-includes/ms-functions.php

@@ -1344 +1344 @@
  * the new blog's ID. It is the first step in creating a new blog.
  *
  * @since MU
- *
- * @global wpdb $wpdb WordPress database abstraction object.
+ * @since 4.9.0 Now wraps `wp_insert_site()`.
  *
  * @param string $domain  The domain of the new site.
  * @param string $path    The path of the new site.
@@ -1353 +1352 @@
  * @return int|false The ID of the new row
  */
 function insert_blog($domain, $path, $site_id) {
-        global $wpdb;
+        $site = new WP_Site( new stdClass() );
+        $site->domain     = $domain;
+        $site->path       = $path;
+        $site->network_id = $site_id;
 
-        $path = trailingslashit($path);
-        $site_id = (int) $site_id;
-
-        $result = $wpdb->insert( $wpdb->blogs, array('site_id' => $site_id, 'domain' => $domain, 'path' => $path, 'registered' => current_time('mysql')) );
-        if ( ! $result )
+        $site = wp_insert_site( $site );
+        if ( is_wp_error( $site ) ) {
                 return false;
+        }
 
-        $blog_id = $wpdb->insert_id;
-        refresh_blog_details( $blog_id );
-
-        wp_maybe_update_network_site_counts();
+        //TODO: Do we need to run the 'refresh_blog_details' hook here for BC?
 
-        return $blog_id;
+        return $site->id;
 }
 
 /**