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

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 	return $stats;
 }
 /**
-* Get one of a user's active blogs
+* Gets one of a user's active blogs.
 *
 * Returns the user's primary blog, if they have one and
 * it is active. If it's inactive, function returns another
 * active blog of the user. If none are found, the user
 * is added as a Subscriber to the Dashboard Blog and that blog
 		return $primary;
 	}
 }
 /**
-* The number of active users in your installation.
+* Gets the number of active sites on the installation.
-*
-* The count is cached and updated twice daily. This is not a live count.
-*
-* @since MU (3.0.0)
-* @since 4.8.0 The `$network_id` parameter has been added.
-*
-* @param int|null $network_id ID of the network. Default is the current network.
-* @return int Number of active users on the network.
-*/
-function get_user_count( $network_id = null ) {
-	return get_network_option( $network_id, 'user_count' );
-}
-/**
-* The number of active sites on your installation.
 *
 * The count is cached and updated twice daily. This is not a live count.
 *
 * @since MU (3.0.0)
 * @since 3.7.0 The `$network_id` parameter has been deprecated.
 	return true;
 }
 /**
-* Remove a user from a blog.
+* Removes a user from a blog.
 *
 * Use the {@see 'remove_user_from_blog'} action to fire an event when
 * users are removed from a blog.
 *
 * Accepts an optional `$reassign` parameter, if you want to
 		update_user_meta( $user_id, 'primary_blog', $new_id );
 		update_user_meta( $user_id, 'source_domain', $new_domain );
 	}
-	// wp_revoke_user( $user_id );
 	$user = get_userdata( $user_id );
 	if ( ! $user ) {
 		restore_current_blog();
 		return new WP_Error( 'user_does_not_exist', __( 'That user does not exist.' ) );
 	}
 	return true;
 }
 /**
-* Get the permalink for a post on another blog.
+* Gets the permalink for a post on another blog.
 *
 * @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 $link;
 }
 /**
-* Get a blog's numeric ID from its URL.
+* Gets a blog's numeric ID from its URL.
 *
 * On a subdirectory installation like example.com/blog1/,
 * $domain will be the root 'example.com' and $path the
 * subdirectory '/blog1/'. With subdomains like blog1.example.com,
 * $domain is 'blog1.example.com' and $path is '/'.
 	 */
 	return apply_filters( 'is_email_address_unsafe', $is_email_address_unsafe, $user_email );
 }
 /**
-* Sanitize and validate data required for a user sign-up.
+* Sanitizes and validates data required for a user sign-up.
 *
 * Verifies the validity and uniqueness of user names and user email addresses,
 * and checks email addresses against allowed and disallowed domains provided by
 * administrators.
 *
 	}
 	if ( ! is_email( $user_email ) ) {
 		$errors->add( 'user_email', __( 'Please enter a valid email address.' ) );
 	} elseif ( is_email_address_unsafe( $user_email ) ) {
-		$errors->add( 'user_email', __( 'You cannot use that email address to signup. We are having problems with them blocking some of our email. Please use another email provider.' ) );
+		$errors->add( 'user_email', __( 'You cannot use that email address to signup. There are problems with them blocking some emails from WordPress. Please use another email provider.' ) );
 	}
 	if ( strlen( $user_name ) < 4 ) {
 		$errors->add( 'user_name', __( 'Username must be at least 4 characters.' ) );
 	}
 		$errors->add( 'user_name', __( 'Sorry, that username already exists!' ) );
 	}
 	// Check if the email address has been used already.
 	if ( email_exists( $user_email ) ) {
-		$errors->add( 'user_email', __( 'Sorry, that email address is already used!' ) );
+		$errors->add(
+			'user_email',
+			sprintf(
+				/* translators: %s: Link to the login page. */
+				__( '<strong>Error:</strong> This email address is already registered. <a href="%s">Log in</a> with this address or choose another one.' ),
+				wp_login_url()
+			)
+		);
 	}
 	// Has someone already signed up for this username?
 	$signup = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->signups WHERE user_login = %s", $user_name ) );
 	if ( $signup instanceof stdClass ) {
 	if ( strlen( $blogname ) < $minimum_site_name_length ) {
 		/* translators: %s: Minimum site name length. */
 		$errors->add( 'blogname', sprintf( _n( 'Site name must be at least %s character.', 'Site name must be at least %s characters.', $minimum_site_name_length ), number_format_i18n( $minimum_site_name_length ) ) );
 	}
-	// Do not allow users to create a blog that conflicts with a page on the main blog.
+	// Do not allow users to create a site that conflicts with a page on the main blog.
 	if ( ! is_subdomain_install() && $wpdb->get_var( $wpdb->prepare( 'SELECT post_name FROM ' . $wpdb->get_blog_prefix( $current_network->site_id ) . "posts WHERE post_type = 'page' AND post_name = %s", $blogname ) ) ) {
 		$errors->add( 'blogname', __( 'Sorry, you may not use that site name.' ) );
 	}
 	// All numeric?
 	}
 	if ( domain_exists( $mydomain, $path, $current_network->id ) ) {
 		$errors->add( 'blogname', __( 'Sorry, that site already exists!' ) );
 	}
+	/*
+	 * Do not allow users to create a site that matches an existing user's login name,
+	 * unless it's the user's own username.
+	 */
 	if ( username_exists( $blogname ) ) {
 		if ( ! is_object( $user ) || ( is_object( $user ) && ( $user->user_login != $blogname ) ) ) {
 			$errors->add( 'blogname', __( 'Sorry, that site is reserved!' ) );
 		}
 	}
 	 */
 	return apply_filters( 'wpmu_validate_blog_signup', $result );
 }
 /**
-* Record site signup information for future activation.
+* Records site signup information for future activation.
 *
 * @since MU (3.0.0)
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 	 */
 	do_action( 'after_signup_site', $domain, $path, $title, $user, $user_email, $key, $meta );
 }
 /**
-* Record user signup information for future activation.
+* Records user signup information for future activation.
 *
 * This function is used when user registration is open but
 * new site registration is not.
 *
 * @since MU (3.0.0)
 	 */
 	do_action( 'after_signup_user', $user, $user_email, $key, $meta );
 }
 /**
-* Send a confirmation request email to a user when they sign up for a new site. The new site will not become active
+* Sends a confirmation request email to a user when they sign up for a new site. The new site will not become active
 * until the confirmation link is clicked.
 *
 * This is the notification function used when site registration
 * is enabled.
 *
 		 * @param array  $meta       Signup meta data. By default, contains the requested privacy setting and lang_id.
 		 */
 		apply_filters(
 			'wpmu_signup_blog_notification_email',
 			/* translators: New site notification email. 1: Activation URL, 2: New site URL. */
-			__( "To activate your blog, please click the following link:\n\n%1\$s\n\nAfter you activate, you will receive *another email* with your login.\n\nAfter you activate, you can visit your site here:\n\n%2\$s" ),
+			__( "To activate your site, please click the following link:\n\n%1\$s\n\nAfter you activate, you will receive *another email* with your login.\n\nAfter you activate, you can visit your site here:\n\n%2\$s" ),
 			$domain,
 			$path,
 			$title,
 			$user_login,
 			$user_email,
 	return true;
 }
 /**
-* Send a confirmation request email to a user when they sign up for a new user account (without signing up for a site
+* Sends a confirmation request email to a user when they sign up for a new user account (without signing up for a site
 * at the same time). The user account will not become active until the confirmation link is clicked.
 *
 * This is the notification function used when no new site has
 * been requested.
 *
 	return true;
 }
 /**
-* Activate a signup.
+* Activates a signup.
 *
 * Hook to {@see 'wpmu_activate_user'} or {@see 'wpmu_activate_blog'} for events
 * that should happen only when users or sites are self-created (since
 * those actions are not called when users and sites are created
 * by a Super Admin).
 	 *
 	 * @since MU (3.0.0)
 	 *
 	 * @param int    $blog_id       Blog ID.
 	 * @param int    $user_id       User ID.
-	 * @param int    $password      User password.
+	 * @param string $password      User password.
 	 * @param string $signup_title  Site title.
 	 * @param array  $meta          Signup meta data. By default, contains the requested privacy setting and lang_id.
 	 */
 	do_action( 'wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta );
 		'meta'     => $meta,
 	);
 }
 /**
-* Deletes am associated signup entry when a user is deleted from the database.
+* Deletes an associated signup entry when a user is deleted from the database.
 *
 * @since 5.5.0
 *
 * @param int      $id       ID of the user to delete.
 * @param int|null $reassign ID of the user to reassign posts and links to.
 	$wpdb->delete( $wpdb->signups, array( 'user_login' => $user->user_login ) );
 }
 /**
-* Create a user.
+* Creates a user.
 *
 * This function runs when a user self-registers as well as when
 * a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events
 * that should affect all new users, but only on Multisite (otherwise
-* use {@see'user_register'}).
+* use {@see 'user_register'}).
 *
 * @since MU (3.0.0)
 *
 * @param string $user_name The new user's login name.
 * @param string $password  The new user's password.
 	return $user_id;
 }
 /**
-* Create a site.
+* Creates a site.
 *
 * This function runs when a user self-registers a new site as well
 * as when a Super Admin creates a new site. Hook to {@see 'wpmu_new_blog'}
 * for events that should affect all new sites.
 *
 	 * to the network administrator.
 	 *
 	 * @since MU (3.0.0)
 	 * @since 5.4.0 The `$blog_id` parameter was added.
 	 *
-	 * @param string $msg     Email body.
+	 * @param string     $msg     Email body.
-	 * @param int    $blog_id The new site's ID.
+	 * @param int|string $blog_id The new site's ID as an integer or numeric string.
 	 */
 	$msg = apply_filters( 'newblog_notify_siteadmin', $msg, $blog_id );
 	/* translators: New site notification email subject. %s: New site URL. */
 	wp_mail( $email, sprintf( __( 'New Site Registration: %s' ), $siteurl ), $msg );
 	return true;
 }
 /**
-* Notify a user that their account activation has been successful.
+* Notifies a user that their account activation has been successful.
 *
 * Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.
 *
 * Filter {@see 'update_welcome_user_email'} and {@see 'update_welcome_user_subject'} to
 * modify the content and subject line of the notification email.
 	return true;
 }
 /**
-* Get the current network.
+* Gets the current network.
 *
 * Returns an object containing the 'id', 'domain', 'path', and 'site_name'
 * properties of the network being viewed.
 *
 * @see wpmu_current_site()
 	global $current_site;
 	return $current_site;
 }
 /**
-* Get a user's most recent post.
+* Gets a user's most recent post.
 *
 * Walks through each of a user's blogs to find the post with
 * the most recent post_date_gmt.
 *
 * @since MU (3.0.0)
 //
 // Misc functions.
 //
 /**
-* Check an array of MIME types against a list of allowed types.
+* Checks an array of MIME types against a list of allowed types.
 *
 * WordPress ships with a set of allowed upload filetypes,
 * which is defined in wp-includes/functions.php in
 * get_allowed_mime_types(). This function is used to filter
 * that list against the filetypes allowed provided by Multisite
 	}
 	return $site_mimes;
 }
 /**
-* Update a blog's post count.
+* Updates a blog's post count.
 *
 * WordPress MS stores a blog's post count as an option so as
 * to avoid extraneous COUNTs when a blog's details are fetched
 * with get_site(). This function is called when posts are published
 * or unpublished to make sure the count stays current.
 	return $global_id;
 }
 /**
-* Ensure that the current site's domain is listed in the allowed redirect host list.
+* Ensures that the current site's domain is listed in the allowed redirect host list.
 *
 * @see wp_validate_redirect()
 * @since MU (3.0.0)
 *
 * @param array|string $deprecated Not used.
 function redirect_this_site( $deprecated = '' ) {
 	return array( get_network()->domain );
 }
 /**
-* Check whether an upload is too big.
+* Checks whether an upload is too big.
 *
 * @since MU (3.0.0)
 *
 * @blessed
 *
 	return $upload;
 }
 /**
-* Add a nonce field to the signup page.
+* Adds a nonce field to the signup page.
 *
 * @since MU (3.0.0)
 */
 function signup_nonce_fields() {
 	$id = mt_rand();
 	echo "<input type='hidden' name='signup_form_id' value='{$id}' />";
 	wp_nonce_field( 'signup_form_' . $id, '_signup_form', false );
 }
 /**
-* Process the signup nonce created in signup_nonce_fields().
+* Processes the signup nonce created in signup_nonce_fields().
 *
 * @since MU (3.0.0)
 *
 * @param array $result
 * @return array
 	return $result;
 }
 /**
-* Correct 404 redirects when NOBLOGREDIRECT is defined.
+* Corrects 404 redirects when NOBLOGREDIRECT is defined.
 *
 * @since MU (3.0.0)
 */
 function maybe_redirect_404() {
 	if ( is_main_site() && is_404() && defined( 'NOBLOGREDIRECT' ) ) {
 		}
 	}
 }
 /**
-* Add a new user to a blog by visiting /newbloguser/{key}/.
+* Adds a new user to a blog by visiting /newbloguser/{key}/.
 *
 * This will only work when the user's details are saved as an option
 * keyed as 'new_user_{key}', where '{key}' is a hash generated for the user to be
 * added, as when a user is invited through the regular WP Add User interface.
 *
 		array( 'response' => 200 )
 	);
 }
 /**
-* Add a user to a blog based on details from maybe_add_existing_user_to_blog().
+* Adds a user to a blog based on details from maybe_add_existing_user_to_blog().
 *
 * @since MU (3.0.0)
 *
 * @param array|false $details {
 *     User details. Must at least contain values for the keys listed below.
 		}
 	}
 }
 /**
-* Correct 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).
 */
 function fix_phpmailer_messageid( $phpmailer ) {
 	$phpmailer->Hostname = get_network()->domain;
 }
 /**
-* Check to see whether a user is marked as a spammer, based on user login.
+* Determines whether a user is marked as a spammer, based on user login.
 *
 * @since MU (3.0.0)
 *
 * @param string|WP_User $user Optional. Defaults to current user. WP_User object,
 *                             or user login name as a string.
 	return $user && isset( $user->spam ) && 1 == $user->spam;
 }
 /**
-* Update this blog's 'public' setting in the global blogs table.
+* Updates this blog's 'public' setting in the global blogs table.
 *
 * Public blogs have a setting of 1, private blogs are 0.
 *
 * @since MU (3.0.0)
 *
 function update_blog_public( $old_value, $value ) {
 	update_blog_status( get_current_blog_id(), 'public', (int) $value );
 }
 /**
-* Check whether users can self-register, based on Network settings.
+* Determines whether users can self-register, based on Network settings.
 *
 * @since MU (3.0.0)
 *
 * @return bool
 */
 	$registration = get_site_option( 'registration' );
 	return ( 'all' === $registration || 'user' === $registration );
 }
 /**
-* Ensure that the welcome message is not empty. Currently unused.
+* Ensures that the welcome message is not empty. Currently unused.
 *
 * @since MU (3.0.0)
 *
 * @param string $text
 * @return string
 	}
 	return $text;
 }
 /**
-* Whether to force SSL on content.
+* Determines whether to force SSL on content.
 *
 * @since 2.8.5
 *
 * @param bool $force
 * @return bool True if forced, false if not forced.
 	return $url;
 }
 /**
-* Schedule update of the network-wide counts for the current network.
+* Schedules update of the network-wide counts for the current network.
 *
 * @since 3.1.0
 */
 function wp_schedule_update_network_counts() {
 	if ( ! is_main_site() ) {
 		wp_schedule_event( time(), 'twicedaily', 'update_network_counts' );
 	}
 }
 /**
-* Update the network-wide counts for the current network.
+* Updates the network-wide counts for the current network.
 *
 * @since 3.1.0
 * @since 4.8.0 The `$network_id` parameter has been added.
 *
 * @param int|null $network_id ID of the network. Default is the current network.
 	wp_update_network_user_counts( $network_id );
 	wp_update_network_site_counts( $network_id );
 }
 /**
-* Update the count of sites for the current network.
+* Updates the count of sites for the current network.
 *
 * If enabled through the {@see 'enable_live_network_counts'} filter, update the sites count
 * on a network when a site is created or its status is updated.
 *
 * @since 3.7.0
 	wp_update_network_site_counts( $network_id );
 }
 /**
-* Update the network-wide users count.
+* Updates the network-wide users count.
 *
 * If enabled through the {@see 'enable_live_network_counts'} filter, update the users count
 * on a network when a user is created or its status is updated.
 *
 * @since 3.7.0
 	wp_update_network_user_counts( $network_id );
 }
 /**
-* Update the network-wide site count.
+* Updates the network-wide site count.
 *
 * @since 3.7.0
 * @since 4.8.0 The `$network_id` parameter has been added.
 *
 * @param int|null $network_id ID of the network. Default is the current network.
 	update_network_option( $network_id, 'blog_count', $count );
 }
 /**
-* Update the network-wide user count.
+* Updates the network-wide user count.
 *
 * @since 3.7.0
 * @since 4.8.0 The `$network_id` parameter has been added.
-*
+* @since 6.0.0 This function is now a wrapper for wp_update_user_counts().
-* @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param int|null $network_id ID of the network. Default is the current network.
 */
 function wp_update_network_user_counts( $network_id = null ) {
-	global $wpdb;
+	wp_update_user_counts( $network_id );
-	$count = $wpdb->get_var( "SELECT COUNT(ID) as c FROM $wpdb->users WHERE spam = '0' AND deleted = '0'" );
-	update_network_option( $network_id, 'user_count', $count );
 }
 /**
 * Returns the space used by the current site.
 *
 	return min( $size, $fileupload_maxk, get_upload_space_available() );
 }
 /**
-* Whether or not we have a large network.
+* Determines whether or not we have a large network.
 *
 * The default criteria for a large network is either more than 10,000 users or more than 10,000 sites.
 * Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.
 *
 * @since 3.3.0
 		$network_id = get_current_network_id();
 	}
 	if ( 'users' === $using ) {
 		$count = get_user_count( $network_id );
+		$is_large_network = wp_is_large_user_count( $network_id );
 		/**
 		 * Filters whether the network is considered large.
 		 *
 		 * @since 3.3.0
 		 * @since 4.8.0 The `$network_id` parameter has been added.
 		 * @param bool   $is_large_network Whether the network has more than 10000 users or sites.
 		 * @param string $component        The component to count. Accepts 'users', or 'sites'.
 		 * @param int    $count            The count of items for the component.
 		 * @param int    $network_id       The ID of the network being checked.
 		 */
-		return apply_filters( 'wp_is_large_network', $count > 10000, 'users', $count, $network_id );
+		return apply_filters( 'wp_is_large_network', $is_large_network, 'users', $count, $network_id );
 	}
 	$count = get_blog_count( $network_id );
 	/** This filter is documented in wp-includes/ms-functions.php */
 	 */
 	return apply_filters( 'subdirectory_reserved_names', $names );
 }
 /**
-* Send a confirmation request email when a change of network admin email address is attempted.
+* Sends a confirmation request email when a change of network admin email address is attempted.
 *
 * The new network admin address will not become active until confirmed.
 *
 * @since 4.9.0
 *
 		restore_previous_locale();
 	}
 }
 /**
-* Send an email to the old network admin email address when the network admin email address changes.
+* Sends an email to the old network admin email address when the network admin email address changes.
 *
 * @since 4.9.0
 *
 * @param string $option_name The relevant database option name.
 * @param string $new_email   The new network admin email address.

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6