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

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 *
 * @since MU (3.0.0)
 *
 * @param int    $blog_id ID of the blog the user is being added to.
 * @param int    $user_id ID of the user being added.
-* @param string $role    The role you want the user to have.
+* @param string $role    User role.
 * @return true|WP_Error True on success or a WP_Error object if the user doesn't exist
 *                       or could not be added.
 */
 function add_user_to_blog( $blog_id, $user_id, $role ) {
 	switch_to_blog( $blog_id );
 	 * @param int $blog_id  ID of the blog the user is being removed from.
 	 * @param int $reassign ID of the user to whom to reassign posts.
 	 */
 	do_action( 'remove_user_from_blog', $user_id, $blog_id, $reassign );
-	// If being removed from the primary blog, set a new primary
+	/*
-	// if the user is assigned to multiple blogs.
+	 * If being removed from the primary blog, set a new primary
+	 * if the user is assigned to multiple blogs.
+	 */
 	$primary_blog = get_user_meta( $user_id, 'primary_blog', true );
 	if ( $primary_blog == $blog_id ) {
 		$new_id     = '';
 		$new_domain = '';
 		$blogs      = get_blogs_of_user( $user_id );
 	}
 	$user->remove_all_caps();
 	$blogs = get_blogs_of_user( $user_id );
-	if ( count( $blogs ) == 0 ) {
+	if ( count( $blogs ) === 0 ) {
 		update_user_meta( $user_id, 'primary_blog', '' );
 		update_user_meta( $user_id, 'source_domain', '' );
 	}
 	if ( $reassign ) {
 			$wpdb->query( $wpdb->prepare( "UPDATE $wpdb->links SET link_owner = %d WHERE link_owner = %d", $reassign, $user_id ) );
 			array_walk( $link_ids, 'clean_bookmark_cache' );
 		}
 	}
+	clean_user_cache( $user_id );
 	restore_current_blog();
 	return true;
 }
 *
 * @since MU (3.0.0) 1.0
 *
 * @param int $blog_id ID of the source blog.
 * @param int $post_id ID of the desired post.
-* @return string The post's permalink
+* @return string The post's permalink.
 */
 function get_blog_permalink( $blog_id, $post_id ) {
 	switch_to_blog( $blog_id );
 	$link = get_permalink( $post_id );
 	restore_current_blog();
 *
 * @since MU (3.0.0)
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param string $domain
+* @param string $domain Website domain.
-* @param string $path   Optional. Not required for subdomain installations.
+* @param string $path   Optional. Not required for subdomain installations. Default '/'.
-* @return int 0 if no blog found, otherwise the ID of the matching blog
+* @return int 0 if no blog found, otherwise the ID of the matching blog.
 */
 function get_blog_id_from_url( $domain, $path = '/' ) {
 	$domain = strtolower( $domain );
 	$path   = strtolower( $path );
 	$id     = wp_cache_get( md5( $domain . $path ), 'blog-id-cache' );
 		foreach ( $banned_names as $banned_domain ) {
 			if ( ! $banned_domain ) {
 				continue;
 			}
-			if ( $email_domain == $banned_domain ) {
+			if ( $email_domain === $banned_domain ) {
 				$is_email_address_unsafe = true;
 				break;
 			}
-			$dotted_domain = ".$banned_domain";
+			if ( str_ends_with( $normalized_email, ".$banned_domain" ) ) {
-			if ( substr( $normalized_email, -strlen( $dotted_domain ) ) === $dotted_domain ) {
 				$is_email_address_unsafe = true;
 				break;
 			}
 		}
 	}
 * @since MU (3.0.0)
 *
 * @global wpdb   $wpdb   WordPress database abstraction object.
 * @global string $domain
 *
-* @param string         $blogname   The blog name provided by the user. Must be unique.
+* @param string         $blogname   The site name provided by the user. Must be unique.
-* @param string         $blog_title The blog title provided by the user.
+* @param string         $blog_title The site title provided by the user.
 * @param WP_User|string $user       Optional. The user object to check against the new site name.
+*                                   Default empty string.
 * @return array {
-*     Array of domain, path, blog name, blog title, user and error messages.
+*     Array of domain, path, site name, site title, user and error messages.
 *
 *     @type string         $domain     Domain for the site.
 *     @type string         $path       Path for the site. Used in subdirectory installations.
 *     @type string         $blogname   The unique site name (slug).
 *     @type string         $blog_title Blog title.
 		if ( ! is_object( $user ) || ( is_object( $user ) && ( $user->user_login != $blogname ) ) ) {
 			$errors->add( 'blogname', __( 'Sorry, that site is reserved!' ) );
 		}
 	}
-	// Has someone already signed up for this domain?
+	/*
-	// TODO: Check email too?
+	 * Has someone already signed up for this domain?
+	 * TODO: Check email too?
+	 */
 	$signup = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->signups WHERE domain = %s AND path = %s", $mydomain, $path ) );
 	if ( $signup instanceof stdClass ) {
 		$diff = time() - mysql2date( 'U', $signup->registered );
 		// If registered more than two days ago, cancel registration and let this signup go through.
 		if ( $diff > 2 * DAY_IN_SECONDS ) {
 	 * Filters site details and error messages following registration.
 	 *
 	 * @since MU (3.0.0)
 	 *
 	 * @param array $result {
-	 *     Array of domain, path, blog name, blog title, user and error messages.
+	 *     Array of domain, path, site name, site title, user and error messages.
 	 *
 	 *     @type string         $domain     Domain for the site.
 	 *     @type string         $path       Path for the site. Used in subdirectory installations.
 	 *     @type string         $blogname   The unique site name (slug).
-	 *     @type string         $blog_title Blog title.
+	 *     @type string         $blog_title Site title.
 	 *     @type string|WP_User $user       By default, an empty string. A user object if provided.
 	 *     @type WP_Error       $errors     WP_Error containing any errors found.
 	 * }
 	 */
 	return apply_filters( 'wpmu_validate_blog_signup', $result );
 * @param string $domain     The new blog domain.
 * @param string $path       The new blog path.
 * @param string $title      The site title.
 * @param string $user_login The user's login name.
 * @param string $user_email The user's email address.
-* @param string $key        The activation key created in wpmu_signup_blog()
+* @param string $key        The activation key created in wpmu_signup_blog().
 * @param array  $meta       Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
 * @return bool
 */
 function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $user_email, $key, $meta = array() ) {
 	/**
 	$from_name       = ( '' !== get_site_option( 'site_name' ) ) ? esc_html( get_site_option( 'site_name' ) ) : 'WordPress';
 	$message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . 'Content-Type: text/plain; charset="' . get_option( 'blog_charset' ) . "\"\n";
 	$user            = get_user_by( 'login', $user_login );
-	$switched_locale = switch_to_locale( get_user_locale( $user ) );
+	$switched_locale = $user && switch_to_user_locale( $user->ID );
 	$message = sprintf(
 		/**
 		 * Filters the message content of the new blog notification email.
 		 *
 	if ( ! apply_filters( 'wpmu_signup_user_notification', $user_login, $user_email, $key, $meta ) ) {
 		return false;
 	}
 	$user            = get_user_by( 'login', $user_login );
-	$switched_locale = switch_to_locale( get_user_locale( $user ) );
+	$switched_locale = $user && switch_to_user_locale( $user->ID );
 	// Send email with activation link.
 	$admin_email = get_site_option( 'admin_email' );
 	if ( '' === $admin_email ) {
 * @since MU (3.0.0)
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param string $key The activation key provided to the user.
-* @return array|WP_Error An array containing information about the activated user and/or blog
+* @return array|WP_Error An array containing information about the activated user and/or blog.
 */
 function wpmu_activate_signup( $key ) {
 	global $wpdb;
 	$signup = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->signups WHERE activation_key = %s", $key ) );
 /**
 * Deletes an associated signup entry when a user is deleted from the database.
 *
 * @since 5.5.0
 *
+* @global wpdb $wpdb WordPress database abstraction object.
+*
 * @param int      $id       ID of the user to delete.
 * @param int|null $reassign ID of the user to reassign posts and links to.
 * @param WP_User  $user     User object.
 */
 function wp_delete_signup_on_user_delete( $id, $reassign, $user ) {
 * @since MU (3.0.0)
 *
 * @param string $user_name The new user's login name.
 * @param string $password  The new user's password.
 * @param string $email     The new user's email address.
-* @return int|false Returns false on failure, or int $user_id on success
+* @return int|false Returns false on failure, or int $user_id on success.
 */
 function wpmu_create_user( $user_name, $password, $email ) {
 	$user_name = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) );
 	$user_id = wp_create_user( $user_name, $password, $email );
 *                           If valid status keys are included ('public', 'archived', 'mature',
 *                           'spam', 'deleted', or 'lang_id') the given site status(es) will be
 *                           updated. Otherwise, keys and values will be used to set options for
 *                           the new site. Default empty array.
 * @param int    $network_id Optional. Network ID. Only relevant on multi-network installations.
+*                           Default 1.
 * @return int|WP_Error Returns WP_Error object on failure, the new site ID on success.
 */
 function wpmu_create_blog( $domain, $path, $title, $user_id, $options = array(), $network_id = 1 ) {
 	$defaults = array(
 		'public' => 0,
 	if ( is_wp_error( $blog_id ) ) {
 		return $blog_id;
 	}
-	wp_cache_set( 'last_changed', microtime(), 'sites' );
+	wp_cache_set_sites_last_changed();
 	return $blog_id;
 }
 /**
 *
 * @since MU (3.0.0)
 *
 * @param string $domain     The domain to be checked.
 * @param string $path       The path to be checked.
-* @param int    $network_id Optional. Network ID. Relevant only on multi-network installations.
+* @param int    $network_id Optional. Network ID. Only relevant on multi-network installations.
+*                           Default 1.
 * @return int|null The site ID if the site name exists, null otherwise.
 */
 function domain_exists( $domain, $path, $network_id = 1 ) {
 	$path   = trailingslashit( $path );
 	$args   = array(
 	 * @since 3.5.0
 	 *
 	 * @param int|null $result     The site ID if the site name exists, null otherwise.
 	 * @param string   $domain     Domain to be checked.
 	 * @param string   $path       Path to be checked.
-	 * @param int      $network_id Network ID. Relevant only on multi-network installations.
+	 * @param int      $network_id Network ID. Only relevant on multi-network installations.
 	 */
 	return apply_filters( 'domain_exists', $result, $domain, $path, $network_id );
 }
 /**
 		return false;
 	}
 	$user = get_userdata( $user_id );
-	$switched_locale = switch_to_locale( get_user_locale( $user ) );
+	$switched_locale = switch_to_user_locale( $user_id );
 	$welcome_email = get_site_option( 'welcome_email' );
 	if ( false == $welcome_email ) {
 		/* translators: Do not translate USERNAME, SITE_NAME, BLOG_URL, PASSWORD: those are placeholders. */
 		$welcome_email = __(
 	$switched_locale = false;
 	$network_admin   = get_user_by( 'email', $email );
 	if ( $network_admin ) {
 		// If the network admin email address corresponds to a user, switch to their locale.
-		$switched_locale = switch_to_locale( get_user_locale( $network_admin ) );
+		$switched_locale = switch_to_user_locale( $network_admin->ID );
 	} else {
 		// Otherwise switch to the locale of the current site.
 		$switched_locale = switch_to_locale( get_locale() );
 	}
 	$welcome_email = get_site_option( 'welcome_user_email' );
 	$user = get_userdata( $user_id );
-	$switched_locale = switch_to_locale( get_user_locale( $user ) );
+	$switched_locale = switch_to_user_locale( $user_id );
 	/**
 	 * Filters the content of the welcome email after user activation.
 	 *
 	 * Content should be formatted for transmission via wp_mail().
 *
 * @see wpmu_current_site()
 *
 * @since MU (3.0.0)
 *
-* @global WP_Network $current_site
+* @global WP_Network $current_site The current network.
 *
-* @return WP_Network
+* @return WP_Network The current network.
 */
 function get_current_site() {
 	global $current_site;
 	return $current_site;
 }
 *
 * @since MU (3.0.0)
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int $user_id
+* @param int $user_id User ID.
-* @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts
+* @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts.
 */
 function get_most_recent_post_of_user( $user_id ) {
 	global $wpdb;
 	$user_blogs       = get_blogs_of_user( (int) $user_id );
 	$most_recent_post = array();
-	// Walk through each blog and get the most recent post
+	/*
-	// published by $user_id.
+	 * Walk through each blog and get the most recent post
+	 * published by $user_id.
+	 */
 	foreach ( (array) $user_blogs as $blog ) {
 		$prefix      = $wpdb->get_blog_prefix( $blog->userblog_id );
 		$recent_post = $wpdb->get_row( $wpdb->prepare( "SELECT ID, post_date_gmt FROM {$prefix}posts WHERE post_author = %d AND post_type = 'post' AND post_status = 'publish' ORDER BY post_date_gmt DESC LIMIT 1", $user_id ), ARRAY_A );
 		// Make sure we found a post.
 function check_upload_mimes( $mimes ) {
 	$site_exts  = explode( ' ', get_site_option( 'upload_filetypes', 'jpg jpeg png gif' ) );
 	$site_mimes = array();
 	foreach ( $site_exts as $ext ) {
 		foreach ( $mimes as $ext_pattern => $mime ) {
-			if ( '' !== $ext && false !== strpos( $ext_pattern, $ext ) ) {
+			if ( '' !== $ext && str_contains( $ext_pattern, $ext ) ) {
 				$site_mimes[ $ext_pattern ] = $mime;
 			}
 		}
 	}
 	return $site_mimes;
 		);
 	}
 }
 /**
-* Maintains a canonical list of terms by syncing terms created for each blog with the global terms table.
-*
-* @since 3.0.0
-*
-* @see term_id_filter
-*
-* @global wpdb $wpdb WordPress database abstraction object.
-*
-* @param int    $term_id    An ID for a term on the current blog.
-* @param string $deprecated Not used.
-* @return int An ID from the global terms table mapped from $term_id.
-*/
-function global_terms( $term_id, $deprecated = '' ) {
-	global $wpdb;
-	static $global_terms_recurse = null;
-	if ( ! global_terms_enabled() ) {
-		return $term_id;
-	}
-	// Prevent a race condition.
-	$recurse_start = false;
-	if ( null === $global_terms_recurse ) {
-		$recurse_start        = true;
-		$global_terms_recurse = 1;
-	} elseif ( 10 < $global_terms_recurse++ ) {
-		return $term_id;
-	}
-	$term_id = (int) $term_id;
-	$c       = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->terms WHERE term_id = %d", $term_id ) );
-	$global_id = $wpdb->get_var( $wpdb->prepare( "SELECT cat_ID FROM $wpdb->sitecategories WHERE category_nicename = %s", $c->slug ) );
-	if ( null == $global_id ) {
-		$used_global_id = $wpdb->get_var( $wpdb->prepare( "SELECT cat_ID FROM $wpdb->sitecategories WHERE cat_ID = %d", $c->term_id ) );
-		if ( null == $used_global_id ) {
-			$wpdb->insert(
-				$wpdb->sitecategories,
-				array(
-					'cat_ID'            => $term_id,
-					'cat_name'          => $c->name,
-					'category_nicename' => $c->slug,
-				)
-			);
-			$global_id = $wpdb->insert_id;
-			if ( empty( $global_id ) ) {
-				return $term_id;
-			}
-		} else {
-			$max_global_id = $wpdb->get_var( "SELECT MAX(cat_ID) FROM $wpdb->sitecategories" );
-			$max_local_id  = $wpdb->get_var( "SELECT MAX(term_id) FROM $wpdb->terms" );
-			$new_global_id = max( $max_global_id, $max_local_id ) + mt_rand( 100, 400 );
-			$wpdb->insert(
-				$wpdb->sitecategories,
-				array(
-					'cat_ID'            => $new_global_id,
-					'cat_name'          => $c->name,
-					'category_nicename' => $c->slug,
-				)
-			);
-			$global_id = $wpdb->insert_id;
-		}
-	} elseif ( $global_id != $term_id ) {
-		$local_id = $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->terms WHERE term_id = %d", $global_id ) );
-		if ( null != $local_id ) {
-			global_terms( $local_id );
-			if ( 10 < $global_terms_recurse ) {
-				$global_id = $term_id;
-			}
-		}
-	}
-	if ( $global_id != $term_id ) {
-		if ( get_option( 'default_category' ) == $term_id ) {
-			update_option( 'default_category', $global_id );
-		}
-		$wpdb->update( $wpdb->terms, array( 'term_id' => $global_id ), array( 'term_id' => $term_id ) );
-		$wpdb->update( $wpdb->term_taxonomy, array( 'term_id' => $global_id ), array( 'term_id' => $term_id ) );
-		$wpdb->update( $wpdb->term_taxonomy, array( 'parent' => $global_id ), array( 'parent' => $term_id ) );
-		clean_term_cache( $term_id );
-	}
-	if ( $recurse_start ) {
-		$global_terms_recurse = null;
-	}
-	return $global_id;
-}
-/**
 * Ensures that the current site's domain is listed in the allowed redirect host list.
 *
 * @see wp_validate_redirect()
 * @since MU (3.0.0)
 *
 /**
 * Checks whether an upload is too big.
 *
 * @since MU (3.0.0)
 *
-* @blessed
+* @param array $upload An array of information about the newly-uploaded file.
-*
-* @param array $upload
 * @return string|array If the upload is under the size limit, $upload is returned. Otherwise returns an error message.
 */
 function upload_is_file_too_big( $upload ) {
 	if ( ! is_array( $upload ) || defined( 'WP_IMPORTING' ) || get_site_option( 'upload_space_check_disabled' ) ) {
 		return $upload;
 * added, as when a user is invited through the regular WP Add User interface.
 *
 * @since MU (3.0.0)
 */
 function maybe_add_existing_user_to_blog() {
-	if ( false === strpos( $_SERVER['REQUEST_URI'], '/newbloguser/' ) ) {
+	if ( ! str_contains( $_SERVER['REQUEST_URI'], '/newbloguser/' ) ) {
 		return;
 	}
 	$parts = explode( '/', $_SERVER['REQUEST_URI'] );
 	$key   = array_pop( $parts );
 		}
 	}
 }
 /**
-* Corrects From host on outgoing mail to match the site domain
+* Corrects From host on outgoing mail to match the site domain.
 *
 * @since MU (3.0.0)
 *
 * @param PHPMailer $phpmailer The PHPMailer instance (passed by reference).
 */
 *
 * Public blogs have a setting of 1, private blogs are 0.
 *
 * @since MU (3.0.0)
 *
-* @param int $old_value
+* @param int $old_value The old public value.
-* @param int $value     The new public value
+* @param int $value     The new public value.
 */
 function update_blog_public( $old_value, $value ) {
 	update_blog_status( get_current_blog_id(), 'public', (int) $value );
 }
 *
 * Useful as a filter.
 *
 * @since 2.8.5
 *
-* @param string $url URL
+* @param string $url URL.
-* @return string URL with https as the scheme
+* @return string URL with https as the scheme.
 */
 function filter_SSL( $url ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	if ( ! is_string( $url ) ) {
-		return get_bloginfo( 'url' ); // Return home blog URL with proper scheme.
+		return get_bloginfo( 'url' ); // Return home site URL with proper scheme.
 	}
 	if ( force_ssl_content() && is_ssl() ) {
 		$url = set_url_scheme( $url, 'https' );
 	}
 /**
 * Returns the upload quota for the current blog.
 *
 * @since MU (3.0.0)
 *
-* @return int Quota in megabytes
+* @return int Quota in megabytes.
 */
 function get_space_allowed() {
 	$space_allowed = get_option( 'blog_upload_space' );
 	if ( ! is_numeric( $space_allowed ) ) {
 /**
 * Determines if there is any upload space left in the current blog's quota.
 *
 * @since 3.0.0
 *
-* @return int of upload space available in bytes
+* @return int of upload space available in bytes.
 */
 function get_upload_space_available() {
 	$allowed = get_space_allowed();
 	if ( $allowed < 0 ) {
 		$allowed = 0;
 *
 * @param int $size Upload size limit in bytes.
 * @return int Upload size limit in bytes.
 */
 function upload_size_limit_filter( $size ) {
-	$fileupload_maxk = KB_IN_BYTES * get_site_option( 'fileupload_maxk', 1500 );
+	$fileupload_maxk         = (int) get_site_option( 'fileupload_maxk', 1500 );
+	$max_fileupload_in_bytes = KB_IN_BYTES * $fileupload_maxk;
 	if ( get_site_option( 'upload_space_check_disabled' ) ) {
-		return min( $size, $fileupload_maxk );
+		return min( $size, $max_fileupload_in_bytes );
 	}
-	return min( $size, $fileupload_maxk, get_upload_space_available() );
+	return min( $size, $max_fileupload_in_bytes, get_upload_space_available() );
 }
 /**
 * Determines whether or not we have a large network.
 *
 * Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.
 *
 * @since 3.3.0
 * @since 4.8.0 The `$network_id` parameter has been added.
 *
-* @param string   $using      'sites or 'users'. Default is 'sites'.
+* @param string   $using      'sites' or 'users'. Default is 'sites'.
 * @param int|null $network_id ID of the network. Default is the current network.
 * @return bool True if the network meets the criteria for large. False otherwise.
 */
 function wp_is_large_network( $using = 'sites', $network_id = null ) {
 	$network_id = (int) $network_id;
 		'hash'     => $hash,
 		'newemail' => $value,
 	);
 	update_site_option( 'network_admin_hash', $new_admin_email );
-	$switched_locale = switch_to_locale( get_user_locale() );
+	$switched_locale = switch_to_user_locale( get_current_user_id() );
 	/* translators: Do not translate USERNAME, ADMIN_URL, EMAIL, SITENAME, SITEURL: those are placeholders. */
 	$email_text = __(
 		'Howdy ###USERNAME###,

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4
child 22	8c2e4d02f4ef