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

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 require_once ABSPATH . WPINC . '/ms-site.php';
 require_once ABSPATH . WPINC . '/ms-network.php';
 /**
-* Update the last_updated field for the current site.
+* Updates the last_updated field for the current site.
 *
 * @since MU (3.0.0)
 */
 function wpmu_update_blogs_date() {
 	$site_id = get_current_blog_id();
 	 */
 	do_action( 'wpmu_blog_updated', $site_id );
 }
 /**
-* Get a full blog URL, given a blog ID.
+* Gets a full site URL, given a site ID.
 *
 * @since MU (3.0.0)
 *
-* @param int $blog_id Blog ID.
+* @param int $blog_id Site ID.
-* @return string Full URL of the blog if found. Empty string if not.
+* @return string Full site URL if found. Empty string if not.
 */
 function get_blogaddress_by_id( $blog_id ) {
 	$bloginfo = get_site( (int) $blog_id );
 	if ( empty( $bloginfo ) ) {
 	return esc_url( $scheme . '://' . $bloginfo->domain . $bloginfo->path );
 }
 /**
-* Get a full blog URL, given a blog name.
+* Gets a full site URL, given a site name.
 *
 * @since MU (3.0.0)
 *
-* @param string $blogname The (subdomain or directory) name
+* @param string $blogname Name of the subdomain or directory.
 * @return string
 */
 function get_blogaddress_by_name( $blogname ) {
 	if ( is_subdomain_install() ) {
 		if ( 'main' === $blogname ) {
 	}
 	return esc_url( $url . '/' );
 }
 /**
-* Retrieves a sites ID given its (subdomain or directory) slug.
+* Retrieves a site's ID given its (subdomain or directory) slug.
 *
 * @since MU (3.0.0)
 * @since 4.7.0 Converted to use `get_sites()`.
 *
 * @param string $slug A site's slug.
 	return array_shift( $site_ids );
 }
 /**
-* Retrieve the details for a blog from the blogs table and blog options.
+* Retrieves the details for a blog from the blogs table and blog options.
 *
 * @since MU (3.0.0)
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param int|string|array $fields  Optional. A blog ID, a blog slug, or an array of fields to query against.
-*                                  If not specified the current blog ID is used.
+*                                  Defaults to the current blog ID.
 * @param bool             $get_all Whether to retrieve all details or only the details in the blogs table.
 *                                  Default is true.
 * @return WP_Site|false Blog details on success. False on failure.
 */
 function get_blog_details( $fields = null, $get_all = true ) {
 			$key  = md5( $fields['domain'] . $fields['path'] );
 			$blog = wp_cache_get( $key, 'blog-lookup' );
 			if ( false !== $blog ) {
 				return $blog;
 			}
-			if ( 'www.' === substr( $fields['domain'], 0, 4 ) ) {
+			if ( str_starts_with( $fields['domain'], 'www.' ) ) {
 				$nowww = substr( $fields['domain'], 4 );
 				$blog  = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) AND path = %s ORDER BY CHAR_LENGTH(domain) DESC", $nowww, $fields['domain'], $fields['path'] ) );
 			} else {
 				$blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s", $fields['domain'], $fields['path'] ) );
 			}
 			$key  = md5( $fields['domain'] );
 			$blog = wp_cache_get( $key, 'blog-lookup' );
 			if ( false !== $blog ) {
 				return $blog;
 			}
-			if ( 'www.' === substr( $fields['domain'], 0, 4 ) ) {
+			if ( str_starts_with( $fields['domain'], 'www.' ) ) {
 				$nowww = substr( $fields['domain'], 4 );
 				$blog  = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) ORDER BY CHAR_LENGTH(domain) DESC", $nowww, $fields['domain'] ) );
 			} else {
 				$blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s", $fields['domain'] ) );
 			}
 	$all     = $get_all ? '' : 'short';
 	$details = wp_cache_get( $blog_id . $all, 'blog-details' );
 	if ( $details ) {
 		if ( ! is_object( $details ) ) {
-			if ( -1 == $details ) {
+			if ( -1 === $details ) {
 				return false;
 			} else {
 				// Clear old pre-serialized objects. Cache clients do better with that.
 				wp_cache_delete( $blog_id . $all, 'blog-details' );
 				unset( $details );
 	} else {
 		$details = wp_cache_get( $blog_id, 'blog-details' );
 		// If short was requested and full cache is set, we can return.
 		if ( $details ) {
 			if ( ! is_object( $details ) ) {
-				if ( -1 == $details ) {
+				if ( -1 === $details ) {
 					return false;
 				} else {
 					// Clear old pre-serialized objects. Cache clients do better with that.
 					wp_cache_delete( $blog_id, 'blog-details' );
 					unset( $details );
 	return $details;
 }
 /**
-* Clear the blog details cache.
+* Clears the blog details cache.
 *
 * @since MU (3.0.0)
 *
 * @param int $blog_id Optional. Blog ID. Defaults to current blog.
 */
 	clean_blog_cache( $blog_id );
 }
 /**
-* Update the details for a blog. Updates the blogs table for a given blog ID.
+* Updates the details for a blog and the blogs table for a given blog ID.
 *
 * @since MU (3.0.0)
-*
-* @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param int   $blog_id Blog ID.
 * @param array $details Array of details keyed by blogs table field names.
 * @return bool True if update succeeds, false otherwise.
 */
 function update_blog_details( $blog_id, $details = array() ) {
-	global $wpdb;
 	if ( empty( $details ) ) {
 		return false;
 	}
 	if ( is_object( $details ) ) {
 	wp_cache_delete( $site_id, 'site-details' );
 	wp_cache_delete( $site_id, 'blog-details' );
 }
 /**
-* Retrieve option value for a given blog id based on name of option.
+* Retrieves option value for a given blog id based on name of option.
 *
 * If the option does not exist or does not have a value, then the return value
 * will be false. This is useful to check whether you need to install an option
 * and is commonly used during installation of plugin options and to test
 * whether upgrading is required.
 *
 * If the option was serialized then it will be unserialized when it is returned.
 *
 * @since MU (3.0.0)
 *
-* @param int    $id      A blog ID. Can be null to refer to the current blog.
+* @param int    $id            A blog ID. Can be null to refer to the current blog.
-* @param string $option  Name of option to retrieve. Expected to not be SQL-escaped.
+* @param string $option        Name of option to retrieve. Expected to not be SQL-escaped.
-* @param mixed  $default Optional. Default value to return if the option does not exist.
+* @param mixed  $default_value Optional. Default value to return if the option does not exist.
 * @return mixed Value set for the option.
 */
-function get_blog_option( $id, $option, $default = false ) {
+function get_blog_option( $id, $option, $default_value = false ) {
 	$id = (int) $id;
 	if ( empty( $id ) ) {
 		$id = get_current_blog_id();
 	}
-	if ( get_current_blog_id() == $id ) {
+	if ( get_current_blog_id() === $id ) {
-		return get_option( $option, $default );
+		return get_option( $option, $default_value );
 	}
 	switch_to_blog( $id );
-	$value = get_option( $option, $default );
+	$value = get_option( $option, $default_value );
 	restore_current_blog();
 	/**
 	 * Filters a blog option value.
 	 *
 	 */
 	return apply_filters( "blog_option_{$option}", $value, $id );
 }
 /**
-* Add a new option for a given blog ID.
+* Adds a new option for a given blog ID.
 *
 * You do not need to serialize values. If the value needs to be serialized, then
 * it will be serialized before it is inserted into the database. Remember,
 * resources can not be serialized or added as an option.
 *
 *
 * @since MU (3.0.0)
 *
 * @param int    $id     A blog ID. Can be null to refer to the current blog.
 * @param string $option Name of option to add. Expected to not be SQL-escaped.
-* @param mixed  $value  Optional. Option value, can be anything. Expected to not be SQL-escaped.
+* @param mixed  $value  Option value, can be anything. Expected to not be SQL-escaped.
 * @return bool True if the option was added, false otherwise.
 */
 function add_blog_option( $id, $option, $value ) {
 	$id = (int) $id;
 	if ( empty( $id ) ) {
 		$id = get_current_blog_id();
 	}
-	if ( get_current_blog_id() == $id ) {
+	if ( get_current_blog_id() === $id ) {
 		return add_option( $option, $value );
 	}
 	switch_to_blog( $id );
 	$return = add_option( $option, $value );
 	return $return;
 }
 /**
-* Removes option by name for a given blog ID. Prevents removal of protected WordPress options.
+* Removes an option by name for a given blog ID. Prevents removal of protected WordPress options.
 *
 * @since MU (3.0.0)
 *
 * @param int    $id     A blog ID. Can be null to refer to the current blog.
 * @param string $option Name of option to remove. Expected to not be SQL-escaped.
 	if ( empty( $id ) ) {
 		$id = get_current_blog_id();
 	}
-	if ( get_current_blog_id() == $id ) {
+	if ( get_current_blog_id() === $id ) {
 		return delete_option( $option );
 	}
 	switch_to_blog( $id );
 	$return = delete_option( $option );
 	return $return;
 }
 /**
-* Update an option for a particular blog.
+* Updates an option for a particular blog.
 *
 * @since MU (3.0.0)
 *
 * @param int    $id         The blog ID.
 * @param string $option     The option key.
 	if ( null !== $deprecated ) {
 		_deprecated_argument( __FUNCTION__, '3.1.0' );
 	}
-	if ( get_current_blog_id() == $id ) {
+	if ( get_current_blog_id() === $id ) {
 		return update_option( $option, $value );
 	}
 	switch_to_blog( $id );
 	$return = update_option( $option, $value );
 	return $return;
 }
 /**
-* Switch the current blog.
+* Switches the current blog.
 *
 * This function is useful if you need to pull posts, or other information,
 * from other blogs. You can switch back afterwards using restore_current_blog().
 *
-* Things that aren't switched:
+* PHP code loaded with the originally requested site, such as code from a plugin or theme, does not switch. See #14941.
-*  - plugins. See #14941
 *
 * @see restore_current_blog()
 * @since MU (3.0.0)
 *
 * @global wpdb            $wpdb               WordPress database abstraction object.
 * @global int             $blog_id
 * @global array           $_wp_switched_stack
 * @global bool            $switched
-* @global string          $table_prefix
+* @global string          $table_prefix       The database table prefix.
 * @global WP_Object_Cache $wp_object_cache
 *
 * @param int  $new_blog_id The ID of the blog to switch to. Default: current blog.
 * @param bool $deprecated  Not used.
 * @return true Always returns true.
 	/*
 	 * If we're switching to the same blog id that we're on,
 	 * set the right vars, do the associated actions, but skip
 	 * the extra unnecessary work
 	 */
-	if ( $new_blog_id == $prev_blog_id ) {
+	if ( $new_blog_id === $prev_blog_id ) {
 		/**
 		 * Fires when the blog is switched.
 		 *
 		 * @since MU (3.0.0)
 		 * @since 5.4.0 The `$context` parameter was added.
 		if ( function_exists( 'wp_cache_add_global_groups' ) ) {
 			if ( is_array( $global_groups ) ) {
 				wp_cache_add_global_groups( $global_groups );
 			} else {
-				wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache', 'networks', 'sites', 'site-details', 'blog_meta' ) );
+				wp_cache_add_global_groups(
+					array(
+						'blog-details',
+						'blog-id-cache',
+						'blog-lookup',
+						'blog_meta',
+						'global-posts',
+						'networks',
+						'network-queries',
+						'sites',
+						'site-details',
+						'site-options',
+						'site-queries',
+						'site-transient',
+						'theme_files',
+						'rss',
+						'users',
+						'user-queries',
+						'user_meta',
+						'useremail',
+						'userlogins',
+						'userslugs',
+					)
+				);
 			}
-			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
+			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );
 		}
 	}
 	/** This filter is documented in wp-includes/ms-blogs.php */
 	do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch' );
 	return true;
 }
 /**
-* Restore the current blog, after calling switch_to_blog().
+* Restores the current blog, after calling switch_to_blog().
 *
 * @see switch_to_blog()
 * @since MU (3.0.0)
 *
 * @global wpdb            $wpdb               WordPress database abstraction object.
 * @global array           $_wp_switched_stack
 * @global int             $blog_id
 * @global bool            $switched
-* @global string          $table_prefix
+* @global string          $table_prefix       The database table prefix.
 * @global WP_Object_Cache $wp_object_cache
 *
 * @return bool True on success, false if we're already on the current blog.
 */
 function restore_current_blog() {
 	}
 	$new_blog_id  = array_pop( $GLOBALS['_wp_switched_stack'] );
 	$prev_blog_id = get_current_blog_id();
-	if ( $new_blog_id == $prev_blog_id ) {
+	if ( $new_blog_id === $prev_blog_id ) {
 		/** This filter is documented in wp-includes/ms-blogs.php */
 		do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'restore' );
 		// If we still have items in the switched stack, consider ourselves still 'switched'.
 		$GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] );
 		if ( function_exists( 'wp_cache_add_global_groups' ) ) {
 			if ( is_array( $global_groups ) ) {
 				wp_cache_add_global_groups( $global_groups );
 			} else {
-				wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache', 'networks', 'sites', 'site-details', 'blog_meta' ) );
+				wp_cache_add_global_groups(
+					array(
+						'blog-details',
+						'blog-id-cache',
+						'blog-lookup',
+						'blog_meta',
+						'global-posts',
+						'networks',
+						'network-queries',
+						'sites',
+						'site-details',
+						'site-options',
+						'site-queries',
+						'site-transient',
+						'theme_files',
+						'rss',
+						'users',
+						'user-queries',
+						'user_meta',
+						'useremail',
+						'userlogins',
+						'userslugs',
+					)
+				);
 			}
-			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
+			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );
 		}
 	}
 	/** This filter is documented in wp-includes/ms-blogs.php */
 	do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'restore' );
 *
 * @param int $new_site_id New site ID.
 * @param int $old_site_id Old site ID.
 */
 function wp_switch_roles_and_user( $new_site_id, $old_site_id ) {
-	if ( $new_site_id == $old_site_id ) {
+	if ( $new_site_id === $old_site_id ) {
 		return;
 	}
 	if ( ! did_action( 'init' ) ) {
 		return;
 	wp_roles()->for_site( $new_site_id );
 	wp_get_current_user()->for_site( $new_site_id );
 }
 /**
-* Determines if switch_to_blog() is in effect
+* Determines if switch_to_blog() is in effect.
 *
 * @since 3.5.0
 *
 * @global array $_wp_switched_stack
 *
 function ms_is_switched() {
 	return ! empty( $GLOBALS['_wp_switched_stack'] );
 }
 /**
-* Check if a particular blog is archived.
+* Checks if a particular blog is archived.
 *
 * @since MU (3.0.0)
 *
 * @param int $id Blog ID.
 * @return string Whether the blog is archived or not.
 function is_archived( $id ) {
 	return get_blog_status( $id, 'archived' );
 }
 /**
-* Update the 'archived' status of a particular blog.
+* Updates the 'archived' status of a particular blog.
 *
 * @since MU (3.0.0)
 *
 * @param int    $id       Blog ID.
 * @param string $archived The new status.
 	update_blog_status( $id, 'archived', $archived );
 	return $archived;
 }
 /**
-* Update a blog details field.
+* Updates a blog details field.
 *
 * @since MU (3.0.0)
 * @since 5.1.0 Use wp_update_site() internally.
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 	return $value;
 }
 /**
-* Get a blog details field.
+* Gets a blog details field.
 *
 * @since MU (3.0.0)
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 	return $wpdb->get_var( $wpdb->prepare( "SELECT %s FROM {$wpdb->blogs} WHERE blog_id = %d", $pref, $id ) );
 }
 /**
-* Get a list of most recently updated blogs.
+* Gets a list of most recently updated blogs.
 *
 * @since MU (3.0.0)
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 /**
 * Handler for updating the current site's posts count when a post is deleted.
 *
 * @since 4.0.0
-*
+* @since 6.2.0 Added the `$post` parameter.
-* @param int $post_id Post ID.
+*
-*/
+* @param int     $post_id Post ID.
-function _update_posts_count_on_delete( $post_id ) {
+* @param WP_Post $post    Post object.
-	$post = get_post( $post_id );
+*/
+function _update_posts_count_on_delete( $post_id, $post ) {
 	if ( ! $post || 'publish' !== $post->post_status || 'post' !== $post->post_type ) {
 		return;
 	}
 	update_posts_count();
 	update_posts_count();
 }
 /**
-* Count number of sites grouped by site status.
+* Counts number of sites grouped by site status.
 *
 * @since 5.3.0
 *
 * @param int $network_id Optional. The network to get counts for. Default is the current network ID.
 * @return int[] {

changeset 21	48c4eec2b7e6
parent 18	be944660c56a
child 22	8c2e4d02f4ef