enmi-conf.org: comparison wp/wp-includes/ms-site.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	if ( false === $wpdb->insert( $wpdb->blogs, $prepared_data ) ) {
 		return new WP_Error( 'db_insert_error', __( 'Could not insert site into the database.' ), $wpdb->last_error );
 	}
-	$new_site = get_site( $wpdb->insert_id );
+	$site_id = (int) $wpdb->insert_id;
+	clean_blog_cache( $site_id );
+	$new_site = get_site( $site_id );
 	if ( ! $new_site ) {
 		return new WP_Error( 'get_site_error', __( 'Could not retrieve site data.' ) );
 	}
-	clean_blog_cache( $new_site );
 	/**
 	 * Fires once a site has been inserted into the database.
 	 *
 	 * @since 5.1.0
 		// WPLANG was passed with `$meta` to the `wpmu_new_blog` hook prior to 5.1.0.
 		if ( ! array_key_exists( 'WPLANG', $meta ) ) {
 			$meta['WPLANG'] = get_network_option( $new_site->network_id, 'WPLANG' );
 		}
-		// Rebuild the data expected by the `wpmu_new_blog` hook prior to 5.1.0 using whitelisted keys.
+		// Rebuild the data expected by the `wpmu_new_blog` hook prior to 5.1.0 using allowed keys.
-		// The `$site_data_whitelist` matches the one used in `wpmu_create_blog()`.
+		// The `$allowed_data_fields` matches the one used in `wpmu_create_blog()`.
-		$site_data_whitelist = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
+		$allowed_data_fields = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
-		$meta                = array_merge( array_intersect_key( $data, array_flip( $site_data_whitelist ) ), $meta );
+		$meta                = array_merge( array_intersect_key( $data, array_flip( $allowed_data_fields ) ), $meta );
 		/**
 		 * Fires immediately after a new site is created.
 		 *
 		 * @since MU (3.0.0)
-		 * @deprecated 5.1.0 Use wp_insert_site
+		 * @deprecated 5.1.0 Use {@see 'wp_insert_site'} instead.
 		 *
 		 * @param int    $site_id    Site ID.
 		 * @param int    $user_id    User ID.
 		 * @param string $domain     Site domain.
 		 * @param string $path       Site path.
 		 * @param int    $network_id Network ID. Only relevant on multi-network installations.
 		 * @param array  $meta       Meta data. Used to set initial site options.
 		 */
-		do_action_deprecated( 'wpmu_new_blog', array( $new_site->id, $user_id, $new_site->domain, $new_site->path, $new_site->network_id, $meta ), '5.1.0', 'wp_insert_site' );
+		do_action_deprecated(
+			'wpmu_new_blog',
+			array( $new_site->id, $user_id, $new_site->domain, $new_site->path, $new_site->network_id, $meta ),
+			'5.1.0',
+			'wp_insert_site'
+		);
 	}
 	return (int) $new_site->id;
 }
 	 *
 	 * @since MU (3.0.0)
 	 * @deprecated 5.1.0
 	 *
 	 * @param int  $site_id The site ID.
-	 * @param bool $drop    True if site's table should be dropped. Default is false.
+	 * @param bool $drop    True if site's table should be dropped. Default false.
 	 */
 	do_action_deprecated( 'delete_blog', array( $old_site->id, true ), '5.1.0' );
 	/**
 	 * Fires when a site's uninitialization routine should be executed.
 	 *
 	 * @since 4.8.0
 	 * @deprecated 5.1.0
 	 *
 	 * @param int  $site_id The site ID.
-	 * @param bool $drop    True if site's tables should be dropped. Default is false.
+	 * @param bool $drop    True if site's tables should be dropped. Default false.
 	 */
 	do_action_deprecated( 'deleted_blog', array( $old_site->id, true ), '5.1.0' );
 	return $old_site;
 }
 	return $_site;
 }
 /**
-* Adds any sites from the given ids to the cache that do not already exist in cache.
+* Adds any sites from the given IDs to the cache that do not already exist in cache.
 *
 * @since 4.6.0
 * @since 5.1.0 Introduced the `$update_meta_cache` parameter.
 * @access private
 *
 * Subsequent calls to `get_site_meta()` will not need to query the database.
 *
 * @since 5.1.0
 *
 * @param array $site_ids List of site IDs.
-* @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
+* @return array|false An array of metadata on success, false if there is nothing to update.
 */
 function update_sitemeta_cache( $site_ids ) {
 	// Ensure this filter is hooked in even if the function is called early.
 	if ( ! has_filter( 'update_blog_metadata_cache', 'wp_check_site_meta_support_prefilter' ) ) {
 		add_filter( 'update_blog_metadata_cache', 'wp_check_site_meta_support_prefilter' );
 *     @type string       $search            Search term(s) to retrieve matching sites for. Default empty.
 *     @type array        $search_columns    Array of column names to be searched. Accepts 'domain' and 'path'.
 *                                           Default empty array.
 *     @type bool         $update_site_cache Whether to prime the cache for found sites. Default true.
 * }
-* @return array|int List of WP_Site objects, a list of site ids when 'fields' is set to 'ids',
+* @return array|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
 *                   or the number of sites when 'count' is passed as a query var.
 */
 function get_sites( $args = array() ) {
 	$query = new WP_Site_Query();
 	 * @param array $data Associative array of site data passed to the respective function.
 	 *                    See {@see wp_insert_site()} for the possibly included data.
 	 */
 	$data = apply_filters( 'wp_normalize_site_data', $data );
-	$whitelist = array( 'domain', 'path', 'network_id', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
+	$allowed_data_fields = array( 'domain', 'path', 'network_id', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
-	$data      = array_intersect_key( wp_parse_args( $data, $defaults ), array_flip( $whitelist ) );
+	$data                = array_intersect_key( wp_parse_args( $data, $defaults ), array_flip( $allowed_data_fields ) );
 	$errors = new WP_Error();
 	/**
 	 * Fires when data should be validated for a site prior to inserting or updating in the database.
 	$args = wp_parse_args(
 		$args,
 		array(
 			'user_id' => 0,
-			/* translators: %d: site ID */
+			/* translators: %d: Site ID. */
 			'title'   => sprintf( __( 'Site %d' ), $site->id ),
 			'options' => array(),
 			'meta'    => array(),
 		)
 	);
 	if ( get_current_blog_id() !== $site->id ) {
 		$switch = true;
 		switch_to_blog( $site->id );
 	}
-	require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
+	require_once ABSPATH . 'wp-admin/includes/upgrade.php';
 	// Set up the database tables.
 	make_db_current_silent( 'blog' );
 	$home_scheme    = 'http';
 	// Populate metadata for the site.
 	populate_site_meta( $site->id, $args['meta'] );
 	// Remove all permissions that may exist for the site.
 	$table_prefix = $wpdb->get_blog_prefix();
-	delete_metadata( 'user', 0, $table_prefix . 'user_level', null, true ); // delete all
+	delete_metadata( 'user', 0, $table_prefix . 'user_level', null, true );   // Delete all.
-	delete_metadata( 'user', 0, $table_prefix . 'capabilities', null, true ); // delete all
+	delete_metadata( 'user', 0, $table_prefix . 'capabilities', null, true ); // Delete all.
 	// Install default site content.
 	wp_install_defaults( $args['user_id'] );
 	// Set the site administrator.
 	$top_dir = $dir;
 	$stack   = array( $dir );
 	$index   = 0;
 	while ( $index < count( $stack ) ) {
-		// Get indexed directory from stack
+		// Get indexed directory from stack.
 		$dir = $stack[ $index ];
 		// phpcs:disable WordPress.PHP.NoSilencedErrors.Discouraged
 		$dh = @opendir( $dir );
 		if ( $dh ) {
 			@closedir( $dh );
 		}
 		$index++;
 	}
-	$stack = array_reverse( $stack ); // Last added dirs are deepest
+	$stack = array_reverse( $stack ); // Last added directories are deepest.
 	foreach ( (array) $stack as $dir ) {
 		if ( $dir != $top_dir ) {
 			@rmdir( $dir );
 		}
 	}
 	 * Returning a non-null value will effectively short-circuit the function, returning
 	 * that value instead.
 	 *
 	 * @since 5.1.0
 	 *
-	 * @param bool|null $pre     The value to return, if not null.
+	 * @param bool|null $pre     The value to return instead. Default null
+	 *                           to continue with the check.
 	 * @param int       $site_id The site ID that is being checked.
 	 */
 	$pre = apply_filters( 'pre_wp_is_site_initialized', null, $site_id );
 	if ( null !== $pre ) {
 		return (bool) $pre;
 	wp_cache_delete( $blog_id, 'site-details' );
 	wp_cache_delete( $blog_id, 'blog-details' );
 	wp_cache_delete( $blog_id . 'short', 'blog-details' );
 	wp_cache_delete( $domain_path_key, 'blog-lookup' );
 	wp_cache_delete( $domain_path_key, 'blog-id-cache' );
-	wp_cache_delete( 'current_blog_' . $blog->domain, 'site-options' );
-	wp_cache_delete( 'current_blog_' . $blog->domain . $blog->path, 'site-options' );
 	wp_cache_delete( $blog_id, 'blog_meta' );
 	/**
 	 * Fires immediately after a site has been removed from the object cache.
 	 *
 	/**
 	 * Fires after the blog details cache is cleared.
 	 *
 	 * @since 3.4.0
-	 * @deprecated 4.9.0 Use clean_site_cache
+	 * @deprecated 4.9.0 Use {@see 'clean_site_cache'} instead.
 	 *
 	 * @param int $blog_id Blog ID.
 	 */
 	do_action_deprecated( 'refresh_blog_details', array( $blog_id ), '4.9.0', 'clean_site_cache' );
 }
 *
 * @since 5.1.0
 *
 * @param int    $site_id    Site ID.
 * @param string $meta_key   Metadata name.
-* @param mixed  $meta_value Optional. Metadata value. Must be serializable if
+* @param mixed  $meta_value Optional. Metadata value. If provided,
-*                           non-scalar. Default empty.
+*                           rows will only be removed that match the value.
+*                           Must be serializable if non-scalar. Default empty.
 * @return bool True on success, false on failure.
 */
 function delete_site_meta( $site_id, $meta_key, $meta_value = '' ) {
 	return delete_metadata( 'blog', $site_id, $meta_key, $meta_value );
 }
 * Retrieves metadata for a site.
 *
 * @since 5.1.0
 *
 * @param int    $site_id Site ID.
-* @param string $key     Optional. The meta key to retrieve. By default, returns
+* @param string $key     Optional. The meta key to retrieve. By default,
-*                        data for all keys. Default empty.
+*                        returns data for all keys. Default empty.
-* @param bool   $single  Optional. Whether to return a single value. Default false.
+* @param bool   $single  Optional. Whether to return a single value.
-* @return mixed Will be an array if $single is false. Will be value of meta data
+*                        This parameter has no effect if $key is not specified.
-*               field if $single is true.
+*                        Default false.
+* @return mixed An array if $single is false. The value of meta data field
+*               if $single is true. False for an invalid $site_id.
 */
 function get_site_meta( $site_id, $key = '', $single = false ) {
 	return get_metadata( 'blog', $site_id, $key, $single );
 }
 * @since 5.1.0
 *
 * @param int    $site_id    Site ID.
 * @param string $meta_key   Metadata key.
 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
-* @param mixed  $prev_value Optional. Previous value to check before removing.
+* @param mixed  $prev_value Optional. Previous value to check before updating.
-*                           Default empty.
+*                           If specified, only update existing metadata entries with
+*                           this value. Otherwise, update all entries. Default empty.
 * @return int|bool Meta ID if the key didn't exist, true on successful update,
-*                  false on failure.
+*                  false on failure or if the value passed to the function
+*                  is the same as the one that is already in the database.
 */
 function update_site_meta( $site_id, $meta_key, $meta_value, $prev_value = '' ) {
 	return update_metadata( 'blog', $site_id, $meta_key, $meta_value, $prev_value );
 }
 * @param mixed $check Skip-value for whether to proceed site meta function execution.
 * @return mixed Original value of $check, or false if site meta is not supported.
 */
 function wp_check_site_meta_support_prefilter( $check ) {
 	if ( ! is_site_meta_supported() ) {
-		/* translators: %s: database table name */
+		/* translators: %s: Database table name. */
 		_doing_it_wrong( __FUNCTION__, sprintf( __( 'The %s table is not installed. Please run the network database upgrade.' ), $GLOBALS['wpdb']->blogmeta ), '5.1.0' );
 		return false;
 	}
 	return $check;

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a