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

Timestamp:

08/01/2018 01:05:44 PM (6 years ago)

Author:

flixos90

Message:

Multisite: Complete the new CRUD API for managing sites.

New functions wp_insert_site( $data ), wp_update_site( $id, $data ) and wp_delete_site( $id ) are introduced to manage site rows in the wp_blogs table, forming the new CRUD API together with the existing get_site() / get_sites(). The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.

New hooks introduced as part of this are the actions wp_insert_site, wp_update_site, wp_delete_site, wp_validate_site_data and the filter wp_normalize_site_data.

At this point, wp_insert_site() does not handle setting up the site's database tables, and wp_delete_site() does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of wpmu_create_blog() and wpmu_delete_blog(). Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.

The existing functions wpmu_create_blog(), update_blog_details(), and wpmu_delete_blog() make use of the respective new counterpart and will be obsolete once #41333 has been completed.

Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.

File:

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

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

@@ -1274 +1274 @@
     $meta     = wp_parse_args( $meta, $defaults );
 
-    $domain = preg_replace( '/\s+/', '', sanitize_user( $domain, true ) );
-
-    if ( is_subdomain_install() ) {
-        $domain = str_replace( '@', '', $domain );
-    }
-
     $title   = strip_tags( $title );
     $user_id = (int) $user_id;
-
-    if ( empty( $path ) ) {
-        $path = '/';
-    }
 
     // Check if the domain has been used already. We should return an error message.
@@ -1296 +1286 @@
     }
 
-    if ( ! $blog_id = insert_blog( $domain, $path, $network_id ) ) {
-        return new WP_Error( 'insert_blog', __( 'Could not create site.' ) );
+    $site_data_whitelist = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
+
+    $site_data = array_merge(
+        array(
+            'domain'     => $domain,
+            'path'       => $path,
+            'network_id' => $network_id,
+        ),
+        array_intersect_key(
+            $meta,
+            array_flip( $site_data_whitelist )
+        )
+    );
+
+    $meta = array_diff_key( $meta, array_flip( $site_data_whitelist ) );
+
+    remove_action( 'update_blog_public', 'wp_update_blog_public_option_on_site_update', 1 );
+    $blog_id = wp_insert_site( $site_data );
+    add_action( 'update_blog_public', 'wp_update_blog_public_option_on_site_update', 1, 2 );
+
+    if ( is_wp_error( $blog_id ) ) {
+        return $blog_id;
     }
 
@@ -1307 +1317 @@
 
     foreach ( $meta as $key => $value ) {
-        if ( in_array( $key, array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ) ) ) {
-            update_blog_status( $blog_id, $key, $value );
-        } else {
-            update_option( $key, $value );
-        }
-    }
-
-    update_option( 'blog_public', (int) $meta['public'] );
+        update_option( $key, $value );
+    }
+
+    update_option( 'blog_public', (int) $site_data['public'] );
 
     if ( ! is_super_admin( $user_id ) && ! get_user_meta( $user_id, 'primary_blog', true ) ) {
@@ -1321 +1327 @@
 
     restore_current_blog();
+
+    $site = get_site( $blog_id );
+
     /**
      * Fires immediately after a new site is created.
@@ -1333 +1342 @@
      * @param array  $meta       Meta data. Used to set initial site options.
      */
-    do_action( 'wpmu_new_blog', $blog_id, $user_id, $domain, $path, $network_id, $meta );
+    do_action( 'wpmu_new_blog', $blog_id, $user_id, $site->domain, $site->path, $site->network_id, $meta );
 
     wp_cache_set( 'last_changed', microtime(), 'sites' );
@@ -1487 +1496 @@
 
 /**
- * Store basic site info in the blogs table.
- *
- * This function creates a row in the wp_blogs table and returns
- * the new blog's ID. It is the first step in creating a new blog.
- *
- * @since MU (3.0.0)
- *
- * @global wpdb $wpdb WordPress database abstraction object.
- *
- * @param string $domain     The domain of the new site.
- * @param string $path       The path of the new site.
- * @param int    $network_id Unless you're running a multi-network installation, be sure to set this value to 1.
- * @return int|false The ID of the new row
- */
-function insert_blog( $domain, $path, $network_id ) {
-    global $wpdb;
-
-    $path       = trailingslashit( $path );
-    $network_id = (int) $network_id;
-
-    $result = $wpdb->insert(
-        $wpdb->blogs, array(
-            'site_id'    => $network_id,
-            'domain'     => $domain,
-            'path'       => $path,
-            'registered' => current_time( 'mysql' ),
-        )
-    );
-    if ( ! $result ) {
-        return false;
-    }
-
-    $blog_id = $wpdb->insert_id;
-    clean_blog_cache( $blog_id );
-
-    wp_maybe_update_network_site_counts( $network_id );
-
-    return $blog_id;
-}
-
-/**
  * Install an empty blog.
  *
@@ -1539 +1507 @@
  * @global WP_Roles $wp_roles
  *
- * @param int    $blog_id    The value returned by insert_blog().
+ * @param int    $blog_id    The value returned by wp_insert_site().
  * @param string $blog_title The title of the new site.
  */