diff -r 490d5cc509ed -r cf61fcea0001 wp/wp-includes/ms-functions.php
--- a/wp/wp-includes/ms-functions.php Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-includes/ms-functions.php Mon Oct 14 17:39:30 2019 +0200
@@ -10,7 +10,7 @@
/**
* Gets the network's site and user counts.
*
- * @since MU 1.0
+ * @since MU (3.0.0)
*
* @return array Site and user count for the network.
*/
@@ -24,29 +24,6 @@
}
/**
- * Get the admin for a domain/path combination.
- *
- * @since MU 1.0
- *
- * @param string $sitedomain Optional. Site domain.
- * @param string $path Optional. Site path.
- * @return array The network admins
- */
-function get_admin_users_for_domain( $sitedomain = '', $path = '' ) {
- global $wpdb;
-
- if ( ! $sitedomain )
- $site_id = $wpdb->siteid;
- else
- $site_id = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM $wpdb->site WHERE domain = %s AND path = %s", $sitedomain, $path ) );
-
- if ( $site_id )
- return $wpdb->get_results( $wpdb->prepare( "SELECT u.ID, u.user_login, u.user_pass FROM $wpdb->users AS u, $wpdb->sitemeta AS sm WHERE sm.meta_key = 'admin_user_id' AND u.ID = sm.meta_value AND sm.site_id = %d", $site_id ), ARRAY_A );
-
- return false;
-}
-
-/**
* Get one of a user's active blogs
*
* Returns the user's primary blog, if they have one and
@@ -55,34 +32,37 @@
* is added as a Subscriber to the Dashboard Blog and that blog
* is returned.
*
- * @since MU 1.0
+ * @since MU (3.0.0)
*
* @param int $user_id The unique ID of the user
- * @return object The blog object
+ * @return WP_Site|void The blog object
*/
function get_active_blog_for_user( $user_id ) {
- global $wpdb;
$blogs = get_blogs_of_user( $user_id );
if ( empty( $blogs ) )
- return null;
+ return;
- if ( !is_multisite() )
- return $blogs[$wpdb->blogid];
+ if ( ! is_multisite() ) {
+ return $blogs[ get_current_blog_id() ];
+ }
$primary_blog = get_user_meta( $user_id, 'primary_blog', true );
$first_blog = current($blogs);
if ( false !== $primary_blog ) {
if ( ! isset( $blogs[ $primary_blog ] ) ) {
update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id );
- $primary = get_blog_details( $first_blog->userblog_id );
+ $primary = get_site( $first_blog->userblog_id );
} else {
- $primary = get_blog_details( $primary_blog );
+ $primary = get_site( $primary_blog );
}
} else {
//TODO Review this call to add_user_to_blog too - to get here the user must have a role on this blog?
- add_user_to_blog( $first_blog->userblog_id, $user_id, 'subscriber' );
- update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id );
- $primary = $first_blog;
+ $result = add_user_to_blog( $first_blog->userblog_id, $user_id, 'subscriber' );
+
+ if ( ! is_wp_error( $result ) ) {
+ update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id );
+ $primary = $first_blog;
+ }
}
if ( ( ! is_object( $primary ) ) || ( $primary->archived == 1 || $primary->spam == 1 || $primary->deleted == 1 ) ) {
@@ -90,9 +70,9 @@
$ret = false;
if ( is_array( $blogs ) && count( $blogs ) > 0 ) {
foreach ( (array) $blogs as $blog_id => $blog ) {
- if ( $blog->site_id != $wpdb->siteid )
+ if ( $blog->site_id != get_current_network_id() )
continue;
- $details = get_blog_details( $blog_id );
+ $details = get_site( $blog_id );
if ( is_object( $details ) && $details->archived == 0 && $details->spam == 0 && $details->deleted == 0 ) {
$ret = $blog;
if ( get_user_meta( $user_id , 'primary_blog', true ) != $blog_id )
@@ -103,7 +83,7 @@
}
}
} else {
- return null;
+ return;
}
return $ret;
} else {
@@ -116,12 +96,14 @@
*
* The count is cached and updated twice daily. This is not a live count.
*
- * @since MU 2.7
+ * @since MU (3.0.0)
+ * @since 4.8.0 The $network_id parameter has been added.
*
- * @return int
+ * @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() {
- return get_site_option( 'user_count' );
+function get_user_count( $network_id = null ) {
+ return get_network_option( $network_id, 'user_count' );
}
/**
@@ -129,22 +111,21 @@
*
* The count is cached and updated twice daily. This is not a live count.
*
- * @since MU 1.0
+ * @since MU (3.0.0)
+ * @since 3.7.0 The $network_id parameter has been deprecated.
+ * @since 4.8.0 The $network_id parameter is now being used.
*
- * @param int $network_id Deprecated, not supported.
- * @return int
+ * @param int|null $network_id ID of the network. Default is the current network.
+ * @return int Number of active sites on the network.
*/
-function get_blog_count( $network_id = 0 ) {
- if ( func_num_args() )
- _deprecated_argument( __FUNCTION__, '3.1' );
-
- return get_site_option( 'blog_count' );
+function get_blog_count( $network_id = null ) {
+ return get_network_option( $network_id, 'blog_count' );
}
/**
* Get a blog post from any site on the network.
*
- * @since MU 1.0
+ * @since MU (3.0.0)
*
* @param int $blog_id ID of the blog.
* @param int $post_id ID of the post you're looking for.
@@ -159,17 +140,16 @@
}
/**
- * Add a user to a blog.
+ * Adds a user to a blog.
*
- * Use the 'add_user_to_blog' action to fire an event when
- * users are added to a blog.
+ * Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
*
- * @since MU 1.0
+ * @since MU (3.0.0)
*
- * @param int $blog_id ID of the blog you're adding the user to.
- * @param int $user_id ID of the user you're adding.
- * @param string $role The role you want the user to have
- * @return bool
+ * @param int $blog_id ID of the blog you're adding the user to.
+ * @param int $user_id ID of the user you're adding.
+ * @param string $role The role you want the user to have
+ * @return true|WP_Error
*/
function add_user_to_blog( $blog_id, $user_id, $role ) {
switch_to_blog($blog_id);
@@ -181,10 +161,33 @@
return new WP_Error( 'user_does_not_exist', __( 'The requested user does not exist.' ) );
}
+ /**
+ * Filters whether a user should be added to a site.
+ *
+ * @since 4.9.0
+ *
+ * @param bool|WP_Error $retval True if the user should be added to the site, false
+ * or error object otherwise.
+ * @param int $user_id User ID.
+ * @param string $role User role.
+ * @param int $blog_id Site ID.
+ */
+ $can_add_user = apply_filters( 'can_add_user_to_blog', true, $user_id, $role, $blog_id );
+
+ if ( true !== $can_add_user ) {
+ restore_current_blog();
+
+ if ( is_wp_error( $can_add_user ) ) {
+ return $can_add_user;
+ }
+
+ return new WP_Error( 'user_cannot_be_added', __( 'User cannot be added to this site.' ) );
+ }
+
if ( !get_user_meta($user_id, 'primary_blog', true) ) {
update_user_meta($user_id, 'primary_blog', $blog_id);
- $details = get_blog_details($blog_id);
- update_user_meta($user_id, 'source_domain', $details->domain);
+ $site = get_site( $blog_id );
+ update_user_meta( $user_id, 'source_domain', $site->domain );
}
$user->set_role($role);
@@ -192,7 +195,7 @@
/**
* Fires immediately after a user is added to a site.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param string $role User role.
@@ -200,6 +203,7 @@
*/
do_action( 'add_user_to_blog', $user_id, $role, $blog_id );
wp_cache_delete( $user_id, 'users' );
+ wp_cache_delete( $blog_id . '_user_count', 'blog-details' );
restore_current_blog();
return true;
}
@@ -207,18 +211,20 @@
/**
* Remove a user from a blog.
*
- * Use the 'remove_user_from_blog' action to fire an event when
+ * 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
+ * Accepts an optional `$reassign` parameter, if you want to
* reassign the user's blog posts to another user upon removal.
*
- * @since MU 1.0
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int $user_id ID of the user you're removing.
- * @param int $blog_id ID of the blog you're removing the user from.
+ * @param int $user_id ID of the user you're removing.
+ * @param int $blog_id ID of the blog you're removing the user from.
* @param string $reassign Optional. A user to whom to reassign posts.
- * @return bool
+ * @return true|WP_Error
*/
function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') {
global $wpdb;
@@ -227,7 +233,7 @@
/**
* Fires before a user is removed from a site.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param int $blog_id Blog ID.
@@ -290,42 +296,9 @@
}
/**
- * Create an empty blog.
- *
- * @since MU 1.0
- *
- * @param string $domain The new blog's domain.
- * @param string $path The new blog's path.
- * @param string $weblog_title The new blog's title.
- * @param int $site_id Optional. Defaults to 1.
- * @return int The ID of the newly created blog
- */
-function create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 ) {
- if ( empty($path) )
- $path = '/';
-
- // Check if the domain has been used already. We should return an error message.
- if ( domain_exists($domain, $path, $site_id) )
- return __( 'ERROR: Site URL already taken.' );
-
- // Need to back up wpdb table names, and create a new wp_blogs entry for new blog.
- // Need to get blog_id from wp_blogs, and create new table names.
- // Must restore table names at the end of function.
-
- if ( ! $blog_id = insert_blog($domain, $path, $site_id) )
- return __( 'ERROR: problem creating site entry.' );
-
- switch_to_blog($blog_id);
- install_blog($blog_id);
- restore_current_blog();
-
- return $blog_id;
-}
-
-/**
* Get the permalink for a post on another blog.
*
- * @since MU 1.0
+ * @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.
@@ -347,15 +320,15 @@
* subdirectory '/blog1/'. With subdomains like blog1.example.com,
* $domain is 'blog1.example.com' and $path is '/'.
*
- * @since MU 2.6.5
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $domain
- * @param string $path Optional. Not required for subdomain installations.
+ * @param string $path Optional. Not required for subdomain installations.
* @return int 0 if no blog found, otherwise the ID of the matching blog
*/
function get_blog_id_from_url( $domain, $path = '/' ) {
- global $wpdb;
-
$domain = strtolower( $domain );
$path = strtolower( $path );
$id = wp_cache_get( md5( $domain . $path ), 'blog-id-cache' );
@@ -365,7 +338,14 @@
elseif ( $id )
return (int) $id;
- $id = $wpdb->get_var( $wpdb->prepare( "SELECT blog_id FROM $wpdb->blogs WHERE domain = %s and path = %s /* get_blog_id_from_url */", $domain, $path ) );
+ $args = array(
+ 'domain' => $domain,
+ 'path' => $path,
+ 'fields' => 'ids',
+ 'number' => 1,
+ );
+ $result = get_sites( $args );
+ $id = array_shift( $result );
if ( ! $id ) {
wp_cache_set( md5( $domain . $path ), -1, 'blog-id-cache' );
@@ -387,7 +367,7 @@
* self-registrations; user creation at wp-admin/network/users.php
* bypasses this check.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $user_email The email provided by the user at registration.
* @return bool Returns true when the email address is banned.
@@ -399,7 +379,7 @@
$is_email_address_unsafe = false;
- if ( $banned_names && is_array( $banned_names ) ) {
+ if ( $banned_names && is_array( $banned_names ) && false !== strpos( $user_email, '@', 1 ) ) {
$banned_names = array_map( 'strtolower', $banned_names );
$normalized_email = strtolower( $user_email );
@@ -423,7 +403,7 @@
}
/**
- * Filter whether an email address is unsafe.
+ * Filters whether an email address is unsafe.
*
* @since 3.5.0
*
@@ -445,7 +425,9 @@
* allows you to process the data in any way you'd like, and unset the relevant errors if
* necessary.
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $user_name The login name provided by the user.
* @param string $user_email The email provided by the user.
@@ -460,7 +442,7 @@
$user_name = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) );
if ( $user_name != $orig_username || preg_match( '/[^a-z0-9]/', $user_name ) ) {
- $errors->add( 'user_name', __( 'Only lowercase letters (a-z) and numbers are allowed.' ) );
+ $errors->add( 'user_name', __( 'Usernames can only contain lowercase letters (a-z) and numbers.' ) );
$user_name = $orig_username;
}
@@ -470,34 +452,44 @@
$errors->add('user_name', __( 'Please enter a username.' ) );
$illegal_names = get_site_option( 'illegal_names' );
- if ( is_array( $illegal_names ) == false ) {
+ if ( ! is_array( $illegal_names ) ) {
$illegal_names = array( 'www', 'web', 'root', 'admin', 'main', 'invite', 'administrator' );
add_site_option( 'illegal_names', $illegal_names );
}
- if ( in_array( $user_name, $illegal_names ) == true )
- $errors->add('user_name', __( 'That username is not allowed.' ) );
+ if ( in_array( $user_name, $illegal_names ) ) {
+ $errors->add( 'user_name', __( 'Sorry, that username is not allowed.' ) );
+ }
+
+ /** This filter is documented in wp-includes/user.php */
+ $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
- if ( 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.'));
+ if ( in_array( strtolower( $user_name ), array_map( 'strtolower', $illegal_logins ) ) ) {
+ $errors->add( 'user_name', __( 'Sorry, that username is not allowed.' ) );
+ }
+
+ 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.' ) );
+ }
if ( strlen( $user_name ) < 4 )
$errors->add('user_name', __( 'Username must be at least 4 characters.' ) );
- if ( strpos( ' ' . $user_name, '_' ) != false )
- $errors->add( 'user_name', __( 'Sorry, usernames may not contain the character “_”!' ) );
+ if ( strlen( $user_name ) > 60 ) {
+ $errors->add( 'user_name', __( 'Username may not be longer than 60 characters.' ) );
+ }
// all numeric?
if ( preg_match( '/^[0-9]*$/', $user_name ) )
$errors->add('user_name', __('Sorry, usernames must have letters too!'));
- if ( !is_email( $user_email ) )
- $errors->add('user_email', __( 'Please enter a valid email address.' ) );
-
$limited_email_domains = get_site_option( 'limited_email_domains' );
- if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) {
+ if ( is_array( $limited_email_domains ) && ! empty( $limited_email_domains ) ) {
$emaildomain = substr( $user_email, 1 + strpos( $user_email, '@' ) );
- if ( in_array( $emaildomain, $limited_email_domains ) == false )
+ if ( ! in_array( $emaildomain, $limited_email_domains ) ) {
$errors->add('user_email', __('Sorry, that email address is not allowed!'));
+ }
}
// Check if the username has been used already.
@@ -534,12 +526,12 @@
$result = array('user_name' => $user_name, 'orig_username' => $orig_username, 'user_email' => $user_email, 'errors' => $errors);
/**
- * Filter the validated user registration details.
+ * Filters the validated user registration details.
*
* This does not allow you to override the username or email of the user during
* registration. The values are solely used for validation and error handling.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param array $result {
* The array of user name, email and the error messages.
@@ -564,23 +556,26 @@
* $user parameter to the function, where $user is the other user, is
* effectively an override of this limitation.
*
- * Filter 'wpmu_validate_blog_signup' if you want to modify
+ * Filter {@see 'wpmu_validate_blog_signup'} if you want to modify
* the way that WordPress validates new site signups.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param string $blogname The blog name provided by the user. Must be unique.
- * @param string $blog_title The blog title provided by the user.
+ * @global wpdb $wpdb
+ * @global string $domain
+ *
+ * @param string $blogname The blog name provided by the user. Must be unique.
+ * @param string $blog_title The blog title provided by the user.
+ * @param WP_User|string $user Optional. The user object to check against the new site name.
* @return array Contains the new site data and error messages.
*/
function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
global $wpdb, $domain;
- $current_site = get_current_site();
- $base = $current_site->path;
+ $current_network = get_network();
+ $base = $current_network->path;
$blog_title = strip_tags( $blog_title );
- $blog_title = substr( $blog_title, 0, 50 );
$errors = new WP_Error();
$illegal_names = get_site_option( 'illegal_names' );
@@ -590,40 +585,39 @@
}
/*
- * On sub dir installs, some names are so illegal, only a filter can
+ * On sub dir installations, some names are so illegal, only a filter can
* spring them from jail.
*/
if ( ! is_subdomain_install() ) {
- $illegal_names = array_merge(
- $illegal_names,
- /**
- * Filter reserved site names on a sub-directory Multisite install.
- *
- * @since 3.0.0
- *
- * @param array $subdirectory_reserved_names Array of reserved names.
- */
- apply_filters( 'subdirectory_reserved_names', array( 'page', 'comments', 'blog', 'files', 'feed' ) )
- );
+ $illegal_names = array_merge( $illegal_names, get_subdirectory_reserved_names() );
}
if ( empty( $blogname ) )
$errors->add('blogname', __( 'Please enter a site name.' ) );
- if ( preg_match( '/[^a-z0-9]+/', $blogname ) )
- $errors->add('blogname', __( 'Only lowercase letters (a-z) and numbers are allowed.' ) );
+ if ( preg_match( '/[^a-z0-9]+/', $blogname ) ) {
+ $errors->add( 'blogname', __( 'Site names can only contain lowercase letters (a-z) and numbers.' ) );
+ }
- if ( in_array( $blogname, $illegal_names ) == true )
+ if ( in_array( $blogname, $illegal_names ) )
$errors->add('blogname', __( 'That name is not allowed.' ) );
- if ( strlen( $blogname ) < 4 && !is_super_admin() )
- $errors->add('blogname', __( 'Site name must be at least 4 characters.' ) );
+ /**
+ * Filters the minimum site name length required when validating a site signup.
+ *
+ * @since 4.8.0
+ *
+ * @param int $length The minimum site name length. Default 4.
+ */
+ $minimum_site_name_length = apply_filters( 'minimum_site_name_length', 4 );
- if ( strpos( $blogname, '_' ) !== false )
- $errors->add( 'blogname', __( 'Sorry, site names may not contain the character “_”!' ) );
+ 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.
- if ( !is_subdomain_install() && $wpdb->get_var( $wpdb->prepare( "SELECT post_name FROM " . $wpdb->get_blog_prefix( $current_site->blog_id ) . "posts WHERE post_type = 'page' AND post_name = %s", $blogname ) ) )
+ 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?
@@ -631,12 +625,12 @@
$errors->add('blogname', __('Sorry, site names must have letters too!'));
/**
- * Filter the new site name during registration.
+ * Filters the new site name during registration.
*
* The name is the site's subdomain or the site's subdirectory
* path depending on the network settings.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $blogname Site name.
*/
@@ -655,11 +649,11 @@
$mydomain = "$domain";
$path = $base.$blogname.'/';
}
- if ( domain_exists($mydomain, $path, $current_site->id) )
+ if ( domain_exists($mydomain, $path, $current_network->id) )
$errors->add( 'blogname', __( 'Sorry, that site already exists!' ) );
if ( username_exists( $blogname ) ) {
- if ( is_object( $user ) == false || ( is_object($user) && ( $user->user_login != $blogname ) ) )
+ if ( ! is_object( $user ) || ( is_object($user) && ( $user->user_login != $blogname ) ) )
$errors->add( 'blogname', __( 'Sorry, that site is reserved!' ) );
}
@@ -677,19 +671,19 @@
$result = array('domain' => $mydomain, 'path' => $path, 'blogname' => $blogname, 'blog_title' => $blog_title, 'user' => $user, 'errors' => $errors);
/**
- * Filter site details and error messages following registration.
+ * Filters site details and error messages following registration.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param array $result {
* Array of domain, path, blog name, blog title, user and error messages.
*
- * @type string $domain Domain for the site.
- * @type string $path Path for the site. Used in subdirectory installs.
- * @type string $blogname The unique site name (slug).
- * @type string $blog_title Blog title.
- * @type string $user User email address.
- * @type WP_Error $errors WP_Error containing any errors found.
+ * @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|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 );
@@ -698,20 +692,38 @@
/**
* Record site signup information for future activation.
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $domain The requested domain.
- * @param string $path The requested path.
- * @param string $title The requested site title.
- * @param string $user The user's requested login name.
+ * @param string $domain The requested domain.
+ * @param string $path The requested path.
+ * @param string $title The requested site title.
+ * @param string $user The user's requested login name.
* @param string $user_email The user's email address.
- * @param array $meta By default, contains the requested privacy setting and lang_id.
+ * @param array $meta Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
function wpmu_signup_blog( $domain, $path, $title, $user, $user_email, $meta = array() ) {
global $wpdb;
- $key = substr( md5( time() . rand() . $domain ), 0, 16 );
- $meta = serialize($meta);
+ $key = substr( md5( time() . wp_rand() . $domain ), 0, 16 );
+
+ /**
+ * Filters the metadata for a site signup.
+ *
+ * The metadata will be serialized prior to storing it in the database.
+ *
+ * @since 4.8.0
+ *
+ * @param array $meta Signup meta data. Default empty array.
+ * @param string $domain The requested domain.
+ * @param string $path The requested path.
+ * @param string $title The requested site title.
+ * @param string $user The user's requested login name.
+ * @param string $user_email The user's email address.
+ * @param string $key The user's activation key.
+ */
+ $meta = apply_filters( 'signup_site_meta', $meta, $domain, $path, $title, $user, $user_email, $key );
$wpdb->insert( $wpdb->signups, array(
'domain' => $domain,
@@ -721,10 +733,23 @@
'user_email' => $user_email,
'registered' => current_time('mysql', true),
'activation_key' => $key,
- 'meta' => $meta
+ 'meta' => serialize( $meta )
) );
- wpmu_signup_blog_notification($domain, $path, $title, $user, $user_email, $key, $meta);
+ /**
+ * Fires after site signup information has been written to the database.
+ *
+ * @since 4.4.0
+ *
+ * @param string $domain The requested domain.
+ * @param string $path The requested path.
+ * @param string $title The requested site title.
+ * @param string $user The user's requested login name.
+ * @param string $user_email The user's email address.
+ * @param string $key The user's activation key.
+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
+ */
+ do_action( 'after_signup_site', $domain, $path, $title, $user, $user_email, $key, $meta );
}
/**
@@ -733,11 +758,13 @@
* This function is used when user registration is open but
* new site registration is not.
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $user The user's requested login name.
+ * @param string $user The user's requested login name.
* @param string $user_email The user's email address.
- * @param array $meta By default, this is an empty array.
+ * @param array $meta Optional. Signup meta data. Default empty array.
*/
function wpmu_signup_user( $user, $user_email, $meta = array() ) {
global $wpdb;
@@ -745,8 +772,21 @@
// Format data
$user = preg_replace( '/\s+/', '', sanitize_user( $user, true ) );
$user_email = sanitize_email( $user_email );
- $key = substr( md5( time() . rand() . $user_email ), 0, 16 );
- $meta = serialize($meta);
+ $key = substr( md5( time() . wp_rand() . $user_email ), 0, 16 );
+
+ /**
+ * Filters the metadata for a user signup.
+ *
+ * The metadata will be serialized prior to storing it in the database.
+ *
+ * @since 4.8.0
+ *
+ * @param array $meta Signup meta data. Default empty array.
+ * @param string $user The user's requested login name.
+ * @param string $user_email The user's email address.
+ * @param string $key The user's activation key.
+ */
+ $meta = apply_filters( 'signup_user_meta', $meta, $user, $user_email, $key );
$wpdb->insert( $wpdb->signups, array(
'domain' => '',
@@ -756,56 +796,67 @@
'user_email' => $user_email,
'registered' => current_time('mysql', true),
'activation_key' => $key,
- 'meta' => $meta
+ 'meta' => serialize( $meta )
) );
- wpmu_signup_user_notification($user, $user_email, $key, $meta);
+ /**
+ * Fires after a user's signup information has been written to the database.
+ *
+ * @since 4.4.0
+ *
+ * @param string $user The user's requested login name.
+ * @param string $user_email The user's email address.
+ * @param string $key The user's activation key.
+ * @param array $meta Signup meta data. Default empty array.
+ */
+ do_action( 'after_signup_user', $user, $user_email, $key, $meta );
}
/**
- * Notify user of signup success.
+ * Send 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.
*
- * Filter 'wpmu_signup_blog_notification' to bypass this function or
+ * Filter {@see 'wpmu_signup_blog_notification'} to bypass this function or
* replace it with your own notification behavior.
*
- * Filter 'wpmu_signup_blog_notification_email' and
- * 'wpmu_signup_blog_notification_subject' to change the content
+ * Filter {@see 'wpmu_signup_blog_notification_email'} and
+ * {@see 'wpmu_signup_blog_notification_subject'} to change the content
* and subject line of the email sent to newly registered users.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param string $domain The new blog domain.
- * @param string $path The new blog path.
- * @param string $title The site title.
- * @param string $user The user's login name.
+ * @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 array $meta By default, contains the requested privacy setting and lang_id.
+ * @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, $user_email, $key, $meta = array() ) {
+function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $user_email, $key, $meta = array() ) {
/**
- * Filter whether to bypass the new site email notification.
+ * Filters whether to bypass the new site email notification.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string|bool $domain Site domain.
* @param string $path Site path.
* @param string $title Site title.
- * @param string $user User login name.
+ * @param string $user_login User login name.
* @param string $user_email User email address.
* @param string $key Activation key created in wpmu_signup_blog().
- * @param array $meta By default, contains the requested privacy setting and lang_id.
+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
- if ( ! apply_filters( 'wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta ) ) {
+ if ( ! apply_filters( 'wpmu_signup_blog_notification', $domain, $path, $title, $user_login, $user_email, $key, $meta ) ) {
return false;
}
// Send email with activation link.
- if ( !is_subdomain_install() || get_current_site()->id != 1 )
+ if ( !is_subdomain_install() || get_current_network_id() != 1 )
$activate_url = network_site_url("wp-activate.php?key=$key");
else
$activate_url = "http://{$domain}{$path}wp-activate.php?key=$key"; // @todo use *_url() API
@@ -816,26 +867,30 @@
$admin_email = 'support@' . $_SERVER['SERVER_NAME'];
$from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
$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 ) );
+
$message = sprintf(
/**
- * Filter the message content of the new blog notification email.
+ * Filters the message content of the new blog notification email.
*
* Content should be formatted for transmission via wp_mail().
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $content Content of the notification email.
* @param string $domain Site domain.
* @param string $path Site path.
* @param string $title Site title.
- * @param string $user User login name.
+ * @param string $user_login User login name.
* @param string $user_email User email address.
* @param string $key Activation key created in wpmu_signup_blog().
- * @param array $meta By default, contains the requested privacy setting and lang_id.
+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
apply_filters( 'wpmu_signup_blog_notification_email',
__( "To activate your blog, please click the following link:\n\n%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%s" ),
- $domain, $path, $title, $user, $user_email, $key, $meta
+ $domain, $path, $title, $user_login, $user_email, $key, $meta
),
$activate_url,
esc_url( "http://{$domain}{$path}" ),
@@ -844,65 +899,75 @@
// TODO: Don't hard code activation link.
$subject = sprintf(
/**
- * Filter the subject of the new blog notification email.
+ * Filters the subject of the new blog notification email.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $subject Subject of the notification email.
* @param string $domain Site domain.
* @param string $path Site path.
* @param string $title Site title.
- * @param string $user User login name.
+ * @param string $user_login User login name.
* @param string $user_email User email address.
* @param string $key Activation key created in wpmu_signup_blog().
- * @param array $meta By default, contains the requested privacy setting and lang_id.
+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
apply_filters( 'wpmu_signup_blog_notification_subject',
- __( '[%1$s] Activate %2$s' ),
- $domain, $path, $title, $user, $user_email, $key, $meta
+ /* translators: New site notification email subject. 1: Network name, 2: New site URL */
+ _x( '[%1$s] Activate %2$s', 'New site notification email subject' ),
+ $domain, $path, $title, $user_login, $user_email, $key, $meta
),
$from_name,
esc_url( 'http://' . $domain . $path )
);
wp_mail( $user_email, wp_specialchars_decode( $subject ), $message, $message_headers );
+
+ if ( $switched_locale ) {
+ restore_previous_locale();
+ }
+
return true;
}
/**
- * Notify user of signup success.
+ * Send 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.
*
- * Filter 'wpmu_signup_user_notification' to bypass this function or
+ * Filter {@see 'wpmu_signup_user_notification'} to bypass this function or
* replace it with your own notification behavior.
*
- * Filter 'wpmu_signup_user_notification_email' and
- * 'wpmu_signup_user_notification_subject' to change the content
+ * Filter {@see 'wpmu_signup_user_notification_email'} and
+ * {@see 'wpmu_signup_user_notification_subject'} to change the content
* and subject line of the email sent to newly registered users.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param string $user The user's login name.
+ * @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_user()
- * @param array $meta By default, an empty array.
+ * @param string $key The activation key created in wpmu_signup_user()
+ * @param array $meta Optional. Signup meta data. Default empty array.
* @return bool
*/
-function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) {
+function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta = array() ) {
/**
- * Filter whether to bypass the email notification for new user sign-up.
+ * Filters whether to bypass the email notification for new user sign-up.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param string $user User login name.
+ * @param string $user_login User login name.
* @param string $user_email User email address.
* @param string $key Activation key created in wpmu_signup_user().
- * @param array $meta Signup meta data.
+ * @param array $meta Signup meta data. Default empty array.
*/
- if ( ! apply_filters( 'wpmu_signup_user_notification', $user, $user_email, $key, $meta ) )
+ 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 ) );
+
// Send email with activation link.
$admin_email = get_site_option( 'admin_email' );
if ( $admin_email == '' )
@@ -911,60 +976,68 @@
$message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
$message = sprintf(
/**
- * Filter the content of the notification email for new user sign-up.
+ * Filters the content of the notification email for new user sign-up.
*
* Content should be formatted for transmission via wp_mail().
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $content Content of the notification email.
- * @param string $user User login name.
+ * @param string $user_login User login name.
* @param string $user_email User email address.
* @param string $key Activation key created in wpmu_signup_user().
- * @param array $meta Signup meta data.
+ * @param array $meta Signup meta data. Default empty array.
*/
apply_filters( 'wpmu_signup_user_notification_email',
__( "To activate your user, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login." ),
- $user, $user_email, $key, $meta
+ $user_login, $user_email, $key, $meta
),
site_url( "wp-activate.php?key=$key" )
);
// TODO: Don't hard code activation link.
$subject = sprintf(
/**
- * Filter the subject of the notification email of new user signup.
+ * Filters the subject of the notification email of new user signup.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $subject Subject of the notification email.
- * @param string $user User login name.
+ * @param string $user_login User login name.
* @param string $user_email User email address.
* @param string $key Activation key created in wpmu_signup_user().
- * @param array $meta Signup meta data.
+ * @param array $meta Signup meta data. Default empty array.
*/
apply_filters( 'wpmu_signup_user_notification_subject',
- __( '[%1$s] Activate %2$s' ),
- $user, $user_email, $key, $meta
+ /* translators: New user notification email subject. 1: Network name, 2: New user login */
+ _x( '[%1$s] Activate %2$s', 'New user notification email subject' ),
+ $user_login, $user_email, $key, $meta
),
$from_name,
- $user
+ $user_login
);
wp_mail( $user_email, wp_specialchars_decode( $subject ), $message, $message_headers );
+
+ if ( $switched_locale ) {
+ restore_previous_locale();
+ }
+
return true;
}
/**
* Activate a signup.
*
- * Hook to 'wpmu_activate_user' or 'wpmu_activate_blog' for events
+ * 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
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $key The activation key provided to the user.
- * @return array 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;
@@ -1002,11 +1075,10 @@
if ( isset( $user_already_exists ) )
return new WP_Error( 'user_already_exists', __( 'That username is already activated.' ), $signup);
- wpmu_welcome_user_notification( $user_id, $password, $meta );
/**
* Fires immediately after a new user is activated.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param int $password User password.
@@ -1016,7 +1088,7 @@
return array( 'user_id' => $user_id, 'password' => $password, 'meta' => $meta );
}
- $blog_id = wpmu_create_blog( $signup->domain, $signup->path, $signup->title, $user_id, $meta, $wpdb->siteid );
+ $blog_id = wpmu_create_blog( $signup->domain, $signup->path, $signup->title, $user_id, $meta, get_current_network_id() );
// TODO: What to do if we create a user but cannot create a blog?
if ( is_wp_error($blog_id) ) {
@@ -1030,17 +1102,16 @@
}
$wpdb->update( $wpdb->signups, array('active' => 1, 'activated' => $now), array('activation_key' => $key) );
- wpmu_welcome_notification($blog_id, $user_id, $password, $signup->title, $meta);
/**
* Fires immediately after a site is activated.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
* @param int $user_id User ID.
* @param int $password User password.
* @param string $signup_title Site title.
- * @param array $meta Signup meta data.
+ * @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 );
@@ -1051,16 +1122,16 @@
* Create a user.
*
* This function runs when a user self-registers as well as when
- * a Super Admin creates a new user. Hook to 'wpmu_new_user' for events
+ * 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 'user_register').
+ * use {@see'user_register'}).
*
- * @since MU
+ * @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|bool Returns false on failure, or int $user_id on success
+ * @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
*/
function wpmu_create_user( $user_name, $password, $email ) {
$user_name = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) );
@@ -1076,7 +1147,7 @@
/**
* Fires immediately after a new user is created.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $user_id User ID.
*/
@@ -1089,26 +1160,33 @@
* Create 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 'wpmu_new_blog'
+ * as when a Super Admin creates a new site. Hook to {@see 'wpmu_new_blog'}
* for events that should affect all new sites.
*
- * On subdirectory installs, $domain is the same as the main site's
+ * On subdirectory installations, $domain is the same as the main site's
* domain, and the path is the subdirectory name (eg 'example.com'
- * and '/blog1/'). On subdomain installs, $domain is the new subdomain +
+ * and '/blog1/'). On subdomain installations, $domain is the new subdomain +
* root domain (eg 'blog1.example.com'), and $path is '/'.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param string $domain The new site's domain.
- * @param string $path The new site's path.
- * @param string $title The new site's title.
- * @param int $user_id The user ID of the new site's admin.
- * @param array $meta Optional. Used to set initial site options.
- * @param int $site_id Optional. Only relevant on multi-network installs.
- * @return mixed Returns WP_Error object on failure, int $blog_id on success
+ * @param string $domain The new site's domain.
+ * @param string $path The new site's path.
+ * @param string $title The new site's title.
+ * @param int $user_id The user ID of the new site's admin.
+ * @param array $meta Optional. Array of key=>value pairs used to set initial site options.
+ * 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.
+ * @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, $meta = array(), $site_id = 1 ) {
- $defaults = array( 'public' => 0 );
+function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $network_id = 1 ) {
+ $defaults = array(
+ 'public' => 0,
+ 'WPLANG' => get_network_option( $network_id, 'WPLANG' ),
+ );
$meta = wp_parse_args( $meta, $defaults );
$domain = preg_replace( '/\s+/', '', sanitize_user( $domain, true ) );
@@ -1123,13 +1201,14 @@
$path = '/';
// Check if the domain has been used already. We should return an error message.
- if ( domain_exists($domain, $path, $site_id) )
+ if ( domain_exists($domain, $path, $network_id) )
return new WP_Error( 'blog_taken', __( 'Sorry, that site already exists!' ) );
- if ( !defined('WP_INSTALLING') )
- define( 'WP_INSTALLING', true );
+ if ( ! wp_installing() ) {
+ wp_installing( true );
+ }
- if ( ! $blog_id = insert_blog($domain, $path, $site_id) )
+ if ( ! $blog_id = insert_blog($domain, $path, $network_id) )
return new WP_Error('insert_blog', __('Could not create site.'));
switch_to_blog($blog_id);
@@ -1145,7 +1224,6 @@
update_option( $key, $value );
}
- add_option( 'WPLANG', get_site_option( 'WPLANG' ) );
update_option( 'blog_public', (int) $meta['public'] );
if ( ! is_super_admin( $user_id ) && ! get_user_meta( $user_id, 'primary_blog', true ) )
@@ -1155,16 +1233,18 @@
/**
* Fires immediately after a new site is created.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param int $blog_id Blog ID.
- * @param int $user_id User ID.
- * @param string $domain Site domain.
- * @param string $path Site path.
- * @param int $site_id Site ID. Only relevant on multi-network installs.
- * @param array $meta Meta data. Used to set initial site options.
+ * @param int $blog_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( 'wpmu_new_blog', $blog_id, $user_id, $domain, $path, $site_id, $meta );
+ do_action( 'wpmu_new_blog', $blog_id, $user_id, $domain, $path, $network_id, $meta );
+
+ wp_cache_set( 'last_changed', microtime(), 'sites' );
return $blog_id;
}
@@ -1172,12 +1252,13 @@
/**
* Notifies the network admin that a new site has been activated.
*
- * Filter 'newblog_notify_siteadmin' to change the content of
+ * Filter {@see 'newblog_notify_siteadmin'} to change the content of
* the notification email.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param int $blog_id The new site's ID.
+ * @param int $blog_id The new site's ID.
+ * @param string $deprecated Not used.
* @return bool
*/
function newblog_notify_siteadmin( $blog_id, $deprecated = '' ) {
@@ -1195,16 +1276,17 @@
$siteurl = site_url();
restore_current_blog();
+ /* translators: New site notification email. 1: Site URL, 2: User IP address, 3: Settings screen URL */
$msg = sprintf( __( 'New Site: %1$s
URL: %2$s
-Remote IP: %3$s
+Remote IP address: %3$s
Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
/**
- * Filter the message body of the new site activation email sent
+ * Filters the message body of the new site activation email sent
* to the network administrator.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $msg Email body.
*/
@@ -1217,10 +1299,10 @@
/**
* Notifies the network admin that a new user has been activated.
*
- * Filter 'newuser_notify_siteadmin' to change the content of
+ * Filter {@see 'newuser_notify_siteadmin'} to change the content of
* the notification email.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $user_id The new user's ID.
* @return bool
@@ -1237,16 +1319,17 @@
$user = get_userdata( $user_id );
$options_site_url = esc_url(network_admin_url('settings.php'));
+ /* translators: New user notification email. 1: User login, 2: User IP address, 3: Settings screen URL */
$msg = sprintf(__('New User: %1$s
-Remote IP: %2$s
+Remote IP address: %2$s
Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
/**
- * Filter the message body of the new user activation email sent
+ * Filters the message body of the new user activation email sent
* to the network administrator.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $msg Email body.
* @param WP_User $user WP_User instance of the new user.
@@ -1257,34 +1340,47 @@
}
/**
- * Check whether a blogname is already taken.
+ * Checks whether a site name is already taken.
+ *
+ * The name is the site's subdomain or the site's subdirectory
+ * path depending on the network settings.
*
* Used during the new site registration process to ensure
- * that each blogname is unique.
+ * that each site name is unique.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param string $domain The domain to be checked.
- * @param string $path The path to be checked.
- * @param int $site_id Optional. Relevant only on multi-network installs.
- * @return int
+ * @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.
+ * @return int|null The site ID if the site name exists, null otherwise.
*/
-function domain_exists($domain, $path, $site_id = 1) {
- global $wpdb;
+function domain_exists( $domain, $path, $network_id = 1 ) {
$path = trailingslashit( $path );
- $result = $wpdb->get_var( $wpdb->prepare("SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s AND site_id = %d", $domain, $path, $site_id) );
+ $args = array(
+ 'network_id' => $network_id,
+ 'domain' => $domain,
+ 'path' => $path,
+ 'fields' => 'ids',
+ 'number' => 1,
+ );
+ $result = get_sites( $args );
+ $result = array_shift( $result );
/**
- * Filter whether a blogname is taken.
+ * Filters whether a site name is taken.
+ *
+ * The name is the site's subdomain or the site's subdirectory
+ * path depending on the network settings.
*
* @since 3.5.0
*
- * @param int|null $result The blog_id if the blogname exists, null otherwise.
- * @param string $domain Domain to be checked.
- * @param string $path Path to be checked.
- * @param int $site_id Site ID. Relevant only on multi-network installs.
+ * @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.
*/
- return apply_filters( 'domain_exists', $result, $domain, $path, $site_id );
+ return apply_filters( 'domain_exists', $result, $domain, $path, $network_id );
}
/**
@@ -1293,27 +1389,29 @@
* 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
+ * @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 $site_id Unless you're running a multi-network install, be sure to set this value to 1.
- * @return int The ID of the new row
+ * @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, $site_id) {
+function insert_blog($domain, $path, $network_id) {
global $wpdb;
$path = trailingslashit($path);
- $site_id = (int) $site_id;
+ $network_id = (int) $network_id;
- $result = $wpdb->insert( $wpdb->blogs, array('site_id' => $site_id, 'domain' => $domain, 'path' => $path, 'registered' => current_time('mysql')) );
+ $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;
- refresh_blog_details( $blog_id );
+ clean_blog_cache( $blog_id );
- wp_maybe_update_network_site_counts();
+ wp_maybe_update_network_site_counts( $network_id );
return $blog_id;
}
@@ -1325,9 +1423,12 @@
* directly, be sure to use switch_to_blog() first, so that $wpdb
* points to the new blog.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param int $blog_id The value returned by insert_blog().
+ * @global wpdb $wpdb
+ * @global WP_Roles $wp_roles
+ *
+ * @param int $blog_id The value returned by insert_blog().
* @param string $blog_title The title of the new site.
*/
function install_blog( $blog_id, $blog_title = '' ) {
@@ -1353,15 +1454,26 @@
// populate_roles() clears previous role definitions so we start over.
$wp_roles = new WP_Roles();
- $url = untrailingslashit( $url );
+ $siteurl = $home = untrailingslashit( $url );
+
+ if ( ! is_subdomain_install() ) {
- update_option( 'siteurl', $url );
- update_option( 'home', $url );
+ if ( 'https' === parse_url( get_site_option( 'siteurl' ), PHP_URL_SCHEME ) ) {
+ $siteurl = set_url_scheme( $siteurl, 'https' );
+ }
+ if ( 'https' === parse_url( get_home_url( get_network()->site_id ), PHP_URL_SCHEME ) ) {
+ $home = set_url_scheme( $home, 'https' );
+ }
+
+ }
+
+ update_option( 'siteurl', $siteurl );
+ update_option( 'home', $home );
if ( get_site_option( 'ms_files_rewriting' ) )
update_option( 'upload_path', UPLOADBLOGSDIR . "/$blog_id/files" );
else
- update_option( 'upload_path', get_blog_option( get_current_site()->blog_id, 'upload_path' ) );
+ update_option( 'upload_path', get_blog_option( get_network()->site_id, 'upload_path' ) );
update_option( 'blogname', wp_unslash( $blog_title ) );
update_option( 'admin_email', '' );
@@ -1377,10 +1489,12 @@
*
* This function creates a row in the wp_blogs table.
*
- * @since MU
+ * @since MU (3.0.0)
* @deprecated MU
* @deprecated Use wp_install_defaults()
*
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
* @param int $blog_id Ignored in this function.
* @param int $user_id
*/
@@ -1399,41 +1513,46 @@
/**
* Notify a user that their blog activation has been successful.
*
- * Filter 'wpmu_welcome_notification' to disable or bypass.
+ * Filter {@see 'wpmu_welcome_notification'} to disable or bypass.
*
- * Filter 'update_welcome_email' and 'update_welcome_subject' to
+ * Filter {@see 'update_welcome_email'} and {@see 'update_welcome_subject'} to
* modify the content and subject line of the notification email.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param int $blog_id
- * @param int $user_id
- * @param string $password
- * @param string $title The new blog's title
- * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization.
+ * @param int $blog_id Blog ID.
+ * @param int $user_id User ID.
+ * @param string $password User password.
+ * @param string $title Site title.
+ * @param array $meta Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
* @return bool
*/
function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) {
- $current_site = get_current_site();
+ $current_network = get_network();
/**
- * Filter whether to bypass the welcome email after site activation.
+ * Filters whether to bypass the welcome email after site activation.
*
* Returning false disables the welcome email.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int|bool $blog_id Blog ID.
* @param int $user_id User ID.
* @param string $password User password.
* @param string $title Site title.
- * @param array $meta Signup meta data.
+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) )
return false;
+ $user = get_userdata( $user_id );
+
+ $switched_locale = switch_to_locale( get_user_locale( $user ) );
+
$welcome_email = get_site_option( 'welcome_email' );
- if ( $welcome_email == false )
+ if ( $welcome_email == false ) {
+ /* translators: Do not translate USERNAME, SITE_NAME, BLOG_URL, PASSWORD: those are placeholders. */
$welcome_email = __( 'Howdy USERNAME,
Your new SITE_NAME site has been successfully set up at:
@@ -1448,29 +1567,29 @@
We hope you enjoy your new site. Thanks!
--The Team @ SITE_NAME' );
+ }
$url = get_blogaddress_by_id($blog_id);
- $user = get_userdata( $user_id );
- $welcome_email = str_replace( 'SITE_NAME', $current_site->site_name, $welcome_email );
+ $welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email );
$welcome_email = str_replace( 'BLOG_TITLE', $title, $welcome_email );
$welcome_email = str_replace( 'BLOG_URL', $url, $welcome_email );
$welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );
$welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
/**
- * Filter the content of the welcome email after site activation.
+ * Filters the content of the welcome email after site activation.
*
* Content should be formatted for transmission via wp_mail().
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $welcome_email Message body of the email.
* @param int $blog_id Blog ID.
* @param int $user_id User ID.
* @param string $password User password.
* @param string $title Site title.
- * @param array $meta Signup meta data.
+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
$welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta );
$admin_email = get_site_option( 'admin_email' );
@@ -1482,49 +1601,57 @@
$message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
$message = $welcome_email;
- if ( empty( $current_site->site_name ) )
- $current_site->site_name = 'WordPress';
+ if ( empty( $current_network->site_name ) )
+ $current_network->site_name = 'WordPress';
+
+ /* translators: New site notification email subject. 1: Network name, 2: New site name */
+ $subject = __( 'New %1$s Site: %2$s' );
/**
- * Filter the subject of the welcome email after site activation.
+ * Filters the subject of the welcome email after site activation.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $subject Subject of the email.
*/
- $subject = apply_filters( 'update_welcome_subject', sprintf( __( 'New %1$s Site: %2$s' ), $current_site->site_name, wp_unslash( $title ) ) );
+ $subject = apply_filters( 'update_welcome_subject', sprintf( $subject, $current_network->site_name, wp_unslash( $title ) ) );
wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $message, $message_headers );
+
+ if ( $switched_locale ) {
+ restore_previous_locale();
+ }
+
return true;
}
/**
* Notify a user that their account activation has been successful.
*
- * Filter 'wpmu_welcome_user_notification' to disable or bypass.
+ * Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.
*
- * Filter 'update_welcome_user_email' and 'update_welcome_user_subject' to
+ * Filter {@see 'update_welcome_user_email'} and {@see 'update_welcome_user_subject'} to
* modify the content and subject line of the notification email.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param int $user_id
- * @param string $password
- * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization.
+ * @param int $user_id User ID.
+ * @param string $password User password.
+ * @param array $meta Optional. Signup meta data. Default empty array.
* @return bool
*/
function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) {
- $current_site = get_current_site();
+ $current_network = get_network();
/**
- * Filter whether to bypass the welcome email after user activation.
+ * Filters whether to bypass the welcome email after user activation.
*
* Returning false disables the welcome email.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $user_id User ID.
* @param string $password User password.
- * @param array $meta Signup meta data.
+ * @param array $meta Signup meta data. Default empty array.
*/
if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) )
return false;
@@ -1533,20 +1660,22 @@
$user = get_userdata( $user_id );
+ $switched_locale = switch_to_locale( get_user_locale( $user ) );
+
/**
- * Filter the content of the welcome email after user activation.
+ * Filters the content of the welcome email after user activation.
*
* Content should be formatted for transmission via wp_mail().
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param type $welcome_email The message body of the account activation success email.
+ * @param string $welcome_email The message body of the account activation success email.
* @param int $user_id User ID.
* @param string $password User password.
- * @param array $meta Signup meta data.
+ * @param array $meta Signup meta data. Default empty array.
*/
$welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );
- $welcome_email = str_replace( 'SITE_NAME', $current_site->site_name, $welcome_email );
+ $welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email );
$welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );
$welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
$welcome_email = str_replace( 'LOGINLINK', wp_login_url(), $welcome_email );
@@ -1560,32 +1689,42 @@
$message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
$message = $welcome_email;
- if ( empty( $current_site->site_name ) )
- $current_site->site_name = 'WordPress';
+ if ( empty( $current_network->site_name ) )
+ $current_network->site_name = 'WordPress';
+
+ /* translators: New user notification email subject. 1: Network name, 2: New user login */
+ $subject = __( 'New %1$s User: %2$s' );
/**
- * Filter the subject of the welcome email after user activation.
+ * Filters the subject of the welcome email after user activation.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $subject Subject of the email.
*/
- $subject = apply_filters( 'update_welcome_user_subject', sprintf( __( 'New %1$s User: %2$s' ), $current_site->site_name, $user->user_login) );
+ $subject = apply_filters( 'update_welcome_user_subject', sprintf( $subject, $current_network->site_name, $user->user_login) );
wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $message, $message_headers );
+
+ if ( $switched_locale ) {
+ restore_previous_locale();
+ }
+
return true;
}
/**
- * Get the current site info.
+ * Get the current network.
*
* Returns an object containing the 'id', 'domain', 'path', and 'site_name'
- * properties of the site being viewed.
+ * properties of the network being viewed.
*
* @see wpmu_current_site()
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @return object
+ * @global WP_Network $current_site
+ *
+ * @return WP_Network
*/
function get_current_site() {
global $current_site;
@@ -1598,7 +1737,9 @@
* Walks through each of a user's blogs to find the post with
* the most recent post_date_gmt.
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $user_id
* @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts
@@ -1644,20 +1785,26 @@
* A helper function that is used primarily to check whether
* a blog has exceeded its allowed upload space.
*
- * @since MU
+ * @since MU (3.0.0)
*
- * @param string $directory
- * @return int
+ * @param string $directory Full path of a directory.
+ * @return int Size of the directory in MB.
*/
function get_dirsize( $directory ) {
$dirsize = get_transient( 'dirsize_cache' );
if ( is_array( $dirsize ) && isset( $dirsize[ $directory ][ 'size' ] ) )
return $dirsize[ $directory ][ 'size' ];
- if ( false == is_array( $dirsize ) )
+ if ( ! is_array( $dirsize ) )
$dirsize = array();
- $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory );
+ // Exclude individual site directories from the total when checking the main site,
+ // as they are subdirectories and should not be counted.
+ if ( is_main_site() ) {
+ $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory, $directory . '/sites' );
+ } else {
+ $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory );
+ }
set_transient( 'dirsize_cache', $dirsize, HOUR_IN_SECONDS );
return $dirsize[ $directory ][ 'size' ];
@@ -1669,18 +1816,21 @@
* Used by get_dirsize() to get a directory's size when it contains
* other directories.
*
- * @since MU
+ * @since MU (3.0.0)
+ * @since 4.3.0 $exclude parameter added.
*
- * @param string $directory
- * @return int
+ * @param string $directory Full path of a directory.
+ * @param string $exclude Optional. Full path of a subdirectory to exclude from the total.
+ * @return int|false Size in MB if a valid directory. False if not.
*/
-function recurse_dirsize( $directory ) {
+function recurse_dirsize( $directory, $exclude = null ) {
$size = 0;
$directory = untrailingslashit( $directory );
- if ( !file_exists($directory) || !is_dir( $directory ) || !is_readable( $directory ) )
+ if ( ! file_exists( $directory ) || ! is_dir( $directory ) || ! is_readable( $directory ) || $directory === $exclude ) {
return false;
+ }
if ($handle = opendir($directory)) {
while(($file = readdir($handle)) !== false) {
@@ -1689,7 +1839,7 @@
if (is_file($path)) {
$size += filesize($path);
} elseif (is_dir($path)) {
- $handlesize = recurse_dirsize($path);
+ $handlesize = recurse_dirsize( $path, $exclude );
if ($handlesize > 0)
$size += $handlesize;
}
@@ -1709,7 +1859,7 @@
* that list against the filetype whitelist provided by Multisite
* Super Admins at wp-admin/network/settings.php.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param array $mimes
* @return array
@@ -1731,10 +1881,14 @@
*
* 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_blog_details(). This function is called when posts
- * are published or unpublished to make sure the count stays current.
+ * with get_site(). This function is called when posts are published
+ * or unpublished to make sure the count stays current.
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $deprecated Not used.
*/
function update_posts_count( $deprecated = '' ) {
global $wpdb;
@@ -1742,9 +1896,11 @@
}
/**
- * Logs user registrations.
+ * Logs the user email, IP, and registration date of a new site.
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $blog_id
* @param int $user_id
@@ -1763,7 +1919,11 @@
*
* @see term_id_filter
*
- * @param int $term_id An ID for a term on the current blog.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @staticvar int $global_terms_recurse
+ *
+ * @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 = '' ) {
@@ -1820,7 +1980,7 @@
clean_term_cache($term_id);
}
- if( $recurse_start )
+ if ( $recurse_start )
$global_terms_recurse = null;
return $global_id;
@@ -1830,28 +1990,32 @@
* Ensure that the current site's domain is listed in the allowed redirect host list.
*
* @see wp_validate_redirect()
- * @since MU
+ * @since MU (3.0.0)
*
+ * @param array|string $deprecated Not used.
* @return array The current site's domain
*/
function redirect_this_site( $deprecated = '' ) {
- return array( get_current_site()->domain );
+ return array( get_network()->domain );
}
/**
* Check whether an upload is too big.
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @blessed
*
* @param array $upload
- * @return mixed If the upload is under the size limit, $upload is returned. Otherwise returns an error message.
+ * @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 ) == false || defined( 'WP_IMPORTING' ) || get_site_option( 'upload_space_check_disabled' ) )
+ if ( ! is_array( $upload ) || defined( 'WP_IMPORTING' ) || get_site_option( 'upload_space_check_disabled' ) )
return $upload;
- if ( strlen( $upload['bits'] ) > ( 1024 * get_site_option( 'fileupload_maxk', 1500 ) ) )
- return sprintf( __( 'This file is too big. Files must be less than %d KB in size.' ) . '
', get_site_option( 'fileupload_maxk', 1500 ));
+ if ( strlen( $upload['bits'] ) > ( KB_IN_BYTES * get_site_option( 'fileupload_maxk', 1500 ) ) ) {
+ return sprintf( __( 'This file is too big. Files must be less than %d KB in size.' ) . '
', get_site_option( 'fileupload_maxk', 1500 ) );
+ }
return $upload;
}
@@ -1859,7 +2023,7 @@
/**
* Add a nonce field to the signup page.
*
- * @since MU
+ * @since MU (3.0.0)
*/
function signup_nonce_fields() {
$id = mt_rand();
@@ -1870,7 +2034,7 @@
/**
* Process the signup nonce created in signup_nonce_fields().
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param array $result
* @return array
@@ -1888,11 +2052,11 @@
/**
* Correct 404 redirects when NOBLOGREDIRECT is defined.
*
- * @since MU
+ * @since MU (3.0.0)
*/
function maybe_redirect_404() {
/**
- * Filter the redirect URL for 404s on the main site.
+ * Filters the redirect URL for 404s on the main site.
*
* The filter is only evaluated if the NOBLOGREDIRECT constant is defined.
*
@@ -1909,17 +2073,17 @@
}
/**
- * Add a new user to a blog by visiting /newbloguser/username/.
+ * Add 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_x', where 'x' is the username of the user to be
+ * 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.
*
- * @since MU
+ * @since MU (3.0.0)
*/
function maybe_add_existing_user_to_blog() {
if ( false === strpos( $_SERVER[ 'REQUEST_URI' ], '/newbloguser/' ) )
- return false;
+ return;
$parts = explode( '/', $_SERVER[ 'REQUEST_URI' ] );
$key = array_pop( $parts );
@@ -1940,38 +2104,41 @@
/**
* Add a user to a blog based on details from maybe_add_existing_user_to_blog().
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param array $details
+ * @return true|WP_Error|void
*/
function add_existing_user_to_blog( $details = false ) {
- global $blog_id;
+ if ( is_array( $details ) ) {
+ $blog_id = get_current_blog_id();
+ $result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] );
- if ( is_array( $details ) ) {
- $result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] );
/**
* Fires immediately after an existing user is added to a site.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $user_id User ID.
- * @param mixed $result True on success or a WP_Error object if the user doesn't exist.
+ * @param mixed $result True on success or a WP_Error object if the user doesn't exist
+ * or could not be added.
*/
do_action( 'added_existing_user', $details['user_id'], $result );
+
+ return $result;
}
- return $result;
}
/**
- * Add a newly created user to the appropriate blog
+ * Adds a newly created user to the appropriate blog
*
* To add a user in general, use add_user_to_blog(). This function
- * is specifically hooked into the wpmu_activate_user action.
+ * is specifically hooked into the {@see 'wpmu_activate_user'} action.
*
- * @since MU
+ * @since MU (3.0.0)
* @see add_user_to_blog()
*
- * @param int $user_id
+ * @param int $user_id
* @param mixed $password Ignored.
* @param array $meta
*/
@@ -1979,28 +2146,34 @@
if ( !empty( $meta[ 'add_to_blog' ] ) ) {
$blog_id = $meta[ 'add_to_blog' ];
$role = $meta[ 'new_role' ];
- remove_user_from_blog($user_id, get_current_site()->blog_id); // remove user from main blog.
- add_user_to_blog( $blog_id, $user_id, $role );
- update_user_meta( $user_id, 'primary_blog', $blog_id );
+ remove_user_from_blog( $user_id, get_network()->site_id ); // remove user from main blog.
+
+ $result = add_user_to_blog( $blog_id, $user_id, $role );
+
+ if ( ! is_wp_error( $result ) ) {
+ update_user_meta( $user_id, 'primary_blog', $blog_id );
+ }
}
}
/**
* Correct From host on outgoing mail to match the site domain
*
- * @since MU
+ * @since MU (3.0.0)
+ *
+ * @param PHPMailer $phpmailer The PHPMailer instance (passed by reference).
*/
function fix_phpmailer_messageid( $phpmailer ) {
- $phpmailer->Hostname = get_current_site()->domain;
+ $phpmailer->Hostname = get_network()->domain;
}
/**
* Check to see whether a user is marked as a spammer, based on user login.
*
- * @since MU
+ * @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.
+ * or user login name as a string.
* @return bool
*/
function is_user_spammy( $user = null ) {
@@ -2020,59 +2193,31 @@
*
* Public blogs have a setting of 1, private blogs are 0.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param int $old_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 );
}
/**
- * Check whether a usermeta key has to do with the current blog.
- *
- * @since MU
- *
- * @param string $key
- * @param int $user_id Optional. Defaults to current user.
- * @param int $blog_id Optional. Defaults to current blog.
- * @return bool
- */
-function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {
- global $wpdb;
-
- $current_user = wp_get_current_user();
- if ( $blog_id == 0 ) {
- $blog_id = $wpdb->blogid;
- }
- $local_key = $wpdb->get_blog_prefix( $blog_id ) . $key;
-
- if ( isset( $current_user->$local_key ) )
- return true;
-
- return false;
-}
-
-/**
* Check whether users can self-register, based on Network settings.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @return bool
*/
function users_can_register_signup_filter() {
$registration = get_site_option('registration');
- if ( $registration == 'all' || $registration == 'user' )
- return true;
-
- return false;
+ return ( $registration == 'all' || $registration == 'user' );
}
/**
* Ensure that the welcome message is not empty. Currently unused.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @param string $text
* @return string
@@ -2080,6 +2225,8 @@
function welcome_user_msg_filter( $text ) {
if ( !$text ) {
remove_filter( 'site_option_welcome_user_email', 'welcome_user_msg_filter' );
+
+ /* translators: Do not translate USERNAME, PASSWORD, LOGINLINK, SITE_NAME: those are placeholders. */
$text = __( 'Howdy USERNAME,
Your new account is set up.
@@ -2102,11 +2249,13 @@
*
* @since 2.8.5
*
- * @param string|bool $force
+ * @staticvar bool $forced_content
+ *
+ * @param bool $force
* @return bool True if forced, false if not forced.
*/
function force_ssl_content( $force = '' ) {
- static $forced_content;
+ static $forced_content = false;
if ( '' != $force ) {
$old_forced = $forced_content;
@@ -2124,7 +2273,7 @@
*
* @since 2.8.5
*
- * @param string URL
+ * @param string $url URL
* @return string URL with https as the scheme
*/
function filter_SSL( $url ) {
@@ -2146,33 +2295,39 @@
if ( !is_main_site() )
return;
- if ( !wp_next_scheduled('update_network_counts') && !defined('WP_INSTALLING') )
+ if ( ! wp_next_scheduled('update_network_counts') && ! wp_installing() )
wp_schedule_event(time(), 'twicedaily', 'update_network_counts');
}
/**
- * Update the network-wide counts for the current network.
+ * Update the network-wide counts for the current network.
*
- * @since 3.1.0
+ * @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.
*/
-function wp_update_network_counts() {
- wp_update_network_user_counts();
- wp_update_network_site_counts();
+function wp_update_network_counts( $network_id = null ) {
+ wp_update_network_user_counts( $network_id );
+ wp_update_network_site_counts( $network_id );
}
/**
* Update the count of sites for the current network.
*
- * If enabled through the 'enable_live_network_counts' filter, update the sites count
+ * 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
+ * @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.
*/
-function wp_maybe_update_network_site_counts() {
- $is_small_network = ! wp_is_large_network( 'sites' );
+function wp_maybe_update_network_site_counts( $network_id = null ) {
+ $is_small_network = ! wp_is_large_network( 'sites', $network_id );
/**
- * Filter whether to update network site or user counts when a new site is created.
+ * Filters whether to update network site or user counts when a new site is created.
*
* @since 3.7.0
*
@@ -2184,49 +2339,70 @@
if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'sites' ) )
return;
- wp_update_network_site_counts();
+ wp_update_network_site_counts( $network_id );
}
/**
* Update the network-wide users count.
*
- * If enabled through the 'enable_live_network_counts' filter, update the 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
+ * @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.
*/
-function wp_maybe_update_network_user_counts() {
- $is_small_network = ! wp_is_large_network( 'users' );
+function wp_maybe_update_network_user_counts( $network_id = null ) {
+ $is_small_network = ! wp_is_large_network( 'users', $network_id );
/** This filter is documented in wp-includes/ms-functions.php */
if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) )
return;
- wp_update_network_user_counts();
+ wp_update_network_user_counts( $network_id );
}
/**
* Update 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.
*/
-function wp_update_network_site_counts() {
- global $wpdb;
+function wp_update_network_site_counts( $network_id = null ) {
+ $network_id = (int) $network_id;
+ if ( ! $network_id ) {
+ $network_id = get_current_network_id();
+ }
- $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(blog_id) as c FROM $wpdb->blogs WHERE site_id = %d AND spam = '0' AND deleted = '0' and archived = '0'", $wpdb->siteid) );
- update_site_option( 'blog_count', $count );
+ $count = get_sites( array(
+ 'network_id' => $network_id,
+ 'spam' => 0,
+ 'deleted' => 0,
+ 'archived' => 0,
+ 'count' => true,
+ ) );
+
+ update_network_option( $network_id, 'blog_count', $count );
}
/**
* Update the network-wide user count.
*
* @since 3.7.0
+ * @since 4.8.0 The $network_id parameter has been added.
+ *
+ * @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() {
+function wp_update_network_user_counts( $network_id = null ) {
global $wpdb;
$count = $wpdb->get_var( "SELECT COUNT(ID) as c FROM $wpdb->users WHERE spam = '0' AND deleted = '0'" );
- update_site_option( 'user_count', $count );
+ update_network_option( $network_id, 'user_count', $count );
}
/**
@@ -2238,7 +2414,7 @@
*/
function get_space_used() {
/**
- * Filter the amount of storage space used by the current site.
+ * Filters the amount of storage space used by the current site.
*
* @since 3.5.0
*
@@ -2247,7 +2423,7 @@
$space_used = apply_filters( 'pre_get_space_used', false );
if ( false === $space_used ) {
$upload_dir = wp_upload_dir();
- $space_used = get_dirsize( $upload_dir['basedir'] ) / 1024 / 1024;
+ $space_used = get_dirsize( $upload_dir['basedir'] ) / MB_IN_BYTES;
}
return $space_used;
@@ -2256,7 +2432,7 @@
/**
* Returns the upload quota for the current blog.
*
- * @since MU
+ * @since MU (3.0.0)
*
* @return int Quota in megabytes
*/
@@ -2266,11 +2442,11 @@
if ( ! is_numeric( $space_allowed ) )
$space_allowed = get_site_option( 'blog_upload_space' );
- if ( empty( $space_allowed ) || ! is_numeric( $space_allowed ) )
+ if ( ! is_numeric( $space_allowed ) )
$space_allowed = 100;
/**
- * Filter the upload quota for the current site.
+ * Filters the upload quota for the current site.
*
* @since 3.7.0
*
@@ -2287,11 +2463,15 @@
* @return int of upload space available in bytes
*/
function get_upload_space_available() {
- $space_allowed = get_space_allowed() * 1024 * 1024;
+ $allowed = get_space_allowed();
+ if ( $allowed < 0 ) {
+ $allowed = 0;
+ }
+ $space_allowed = $allowed * MB_IN_BYTES;
if ( get_site_option( 'upload_space_check_disabled' ) )
return $space_allowed;
- $space_used = get_space_used() * 1024 * 1024;
+ $space_used = get_space_used() * MB_IN_BYTES;
if ( ( $space_allowed - $space_used ) <= 0 )
return 0;
@@ -2313,12 +2493,15 @@
}
/**
+ * Filters the maximum upload file size allowed, in bytes.
+ *
* @since 3.0.0
*
- * @return int of upload size limit in bytes
+ * @param int $size Upload size limit in bytes.
+ * @return int Upload size limit in bytes.
*/
function upload_size_limit_filter( $size ) {
- $fileupload_maxk = 1024 * get_site_option( 'fileupload_maxk', 1500 );
+ $fileupload_maxk = KB_IN_BYTES * get_site_option( 'fileupload_maxk', 1500 );
if ( get_site_option( 'upload_space_check_disabled' ) )
return min( $size, $fileupload_maxk );
@@ -2329,105 +2512,233 @@
* 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 'wp_is_large_network' filter.
+ * Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.
*
* @since 3.3.0
- * @param string $using 'sites or 'users'. Default is 'sites'.
+ * @since 4.8.0 The $network_id parameter has been added.
+ *
+ * @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' ) {
+function wp_is_large_network( $using = 'sites', $network_id = null ) {
+ $network_id = (int) $network_id;
+ if ( ! $network_id ) {
+ $network_id = get_current_network_id();
+ }
+
if ( 'users' == $using ) {
- $count = get_user_count();
+ $count = get_user_count( $network_id );
/**
- * Filter whether the network is considered large.
+ * 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 );
+ return apply_filters( 'wp_is_large_network', $count > 10000, 'users', $count, $network_id );
}
- $count = get_blog_count();
+ $count = get_blog_count( $network_id );
/** This filter is documented in wp-includes/ms-functions.php */
- return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count );
+ return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count, $network_id );
}
+/**
+ * Retrieves a list of reserved site on a sub-directory Multisite installation.
+ *
+ * @since 4.4.0
+ *
+ * @return array $names Array of reserved subdirectory names.
+ */
+function get_subdirectory_reserved_names() {
+ $names = array(
+ 'page', 'comments', 'blog', 'files', 'feed', 'wp-admin',
+ 'wp-content', 'wp-includes', 'wp-json', 'embed'
+ );
+
+ /**
+ * Filters reserved site names on a sub-directory Multisite installation.
+ *
+ * @since 3.0.0
+ * @since 4.4.0 'wp-admin', 'wp-content', 'wp-includes', 'wp-json', and 'embed' were added
+ * to the reserved names list.
+ *
+ * @param array $subdirectory_reserved_names Array of reserved names.
+ */
+ return apply_filters( 'subdirectory_reserved_names', $names );
+}
/**
- * Return an array of sites for a network or networks.
+ * Send a confirmation request email when a change of network admin email address is attempted.
*
- * @since 3.7.0
- *
- * @param array $args {
- * Array of default arguments. Optional.
+ * The new network admin address will not become active until confirmed.
*
- * @type int|array $network_id A network ID or array of network IDs. Set to null to retrieve sites
- * from all networks. Defaults to current network ID.
- * @type int $public Retrieve public or non-public sites. Default null, for any.
- * @type int $archived Retrieve archived or non-archived sites. Default null, for any.
- * @type int $mature Retrieve mature or non-mature sites. Default null, for any.
- * @type int $spam Retrieve spam or non-spam sites. Default null, for any.
- * @type int $deleted Retrieve deleted or non-deleted sites. Default null, for any.
- * @type int $limit Number of sites to limit the query to. Default 100.
- * @type int $offset Exclude the first x sites. Used in combination with the $limit parameter. Default 0.
- * }
- * @return array An empty array if the install is considered "large" via wp_is_large_network(). Otherwise,
- * an associative array of site data arrays, each containing the site (network) ID, blog ID,
- * site domain and path, dates registered and modified, and the language ID. Also, boolean
- * values for whether the site is public, archived, mature, spam, and/or deleted.
+ * @since 4.9.0
+ *
+ * @param string $old_value The old network admin email address.
+ * @param string $value The proposed new network admin email address.
*/
-function wp_get_sites( $args = array() ) {
- global $wpdb;
-
- if ( wp_is_large_network() )
- return array();
-
- $defaults = array(
- 'network_id' => $wpdb->siteid,
- 'public' => null,
- 'archived' => null,
- 'mature' => null,
- 'spam' => null,
- 'deleted' => null,
- 'limit' => 100,
- 'offset' => 0,
- );
-
- $args = wp_parse_args( $args, $defaults );
-
- $query = "SELECT * FROM $wpdb->blogs WHERE 1=1 ";
-
- if ( isset( $args['network_id'] ) && ( is_array( $args['network_id'] ) || is_numeric( $args['network_id'] ) ) ) {
- $network_ids = implode( ',', wp_parse_id_list( $args['network_id'] ) );
- $query .= "AND site_id IN ($network_ids) ";
+function update_network_option_new_admin_email( $old_value, $value ) {
+ if ( $value == get_site_option( 'admin_email' ) || ! is_email( $value ) ) {
+ return;
}
- if ( isset( $args['public'] ) )
- $query .= $wpdb->prepare( "AND public = %d ", $args['public'] );
+ $hash = md5( $value . time() . mt_rand() );
+ $new_admin_email = array(
+ 'hash' => $hash,
+ 'newemail' => $value,
+ );
+ update_site_option( 'network_admin_hash', $new_admin_email );
+
+ $switched_locale = switch_to_locale( get_user_locale() );
+
+ /* translators: Do not translate USERNAME, ADMIN_URL, EMAIL, SITENAME, SITEURL: those are placeholders. */
+ $email_text = __( 'Howdy ###USERNAME###,
- if ( isset( $args['archived'] ) )
- $query .= $wpdb->prepare( "AND archived = %d ", $args['archived'] );
+You recently requested to have the network admin email address on
+your network changed.
+
+If this is correct, please click on the following link to change it:
+###ADMIN_URL###
- if ( isset( $args['mature'] ) )
- $query .= $wpdb->prepare( "AND mature = %d ", $args['mature'] );
+You can safely ignore and delete this email if you do not want to
+take this action.
+
+This email has been sent to ###EMAIL###
+
+Regards,
+All at ###SITENAME###
+###SITEURL###' );
- if ( isset( $args['spam'] ) )
- $query .= $wpdb->prepare( "AND spam = %d ", $args['spam'] );
-
- if ( isset( $args['deleted'] ) )
- $query .= $wpdb->prepare( "AND deleted = %d ", $args['deleted'] );
+ /**
+ * Filters the text of the email sent when a change of network admin email address is attempted.
+ *
+ * The following strings have a special meaning and will get replaced dynamically:
+ * ###USERNAME### The current user's username.
+ * ###ADMIN_URL### The link to click on to confirm the email change.
+ * ###EMAIL### The proposed new network admin email address.
+ * ###SITENAME### The name of the network.
+ * ###SITEURL### The URL to the network.
+ *
+ * @since 4.9.0
+ *
+ * @param string $email_text Text in the email.
+ * @param array $new_admin_email {
+ * Data relating to the new network admin email address.
+ *
+ * @type string $hash The secure hash used in the confirmation link URL.
+ * @type string $newemail The proposed new network admin email address.
+ * }
+ */
+ $content = apply_filters( 'new_network_admin_email_content', $email_text, $new_admin_email );
- if ( isset( $args['limit'] ) && $args['limit'] ) {
- if ( isset( $args['offset'] ) && $args['offset'] )
- $query .= $wpdb->prepare( "LIMIT %d , %d ", $args['offset'], $args['limit'] );
- else
- $query .= $wpdb->prepare( "LIMIT %d ", $args['limit'] );
+ $current_user = wp_get_current_user();
+ $content = str_replace( '###USERNAME###', $current_user->user_login, $content );
+ $content = str_replace( '###ADMIN_URL###', esc_url( network_admin_url( 'settings.php?network_admin_hash=' . $hash ) ), $content );
+ $content = str_replace( '###EMAIL###', $value, $content );
+ $content = str_replace( '###SITENAME###', wp_specialchars_decode( get_site_option( 'site_name' ), ENT_QUOTES ), $content );
+ $content = str_replace( '###SITEURL###', network_home_url(), $content );
+
+ wp_mail( $value, sprintf( __( '[%s] New Network Admin Email Address' ), wp_specialchars_decode( get_site_option( 'site_name' ), ENT_QUOTES ) ), $content );
+
+ if ( $switched_locale ) {
+ restore_previous_locale();
+ }
+}
+
+/**
+ * Send 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.
+ * @param string $old_email The old network admin email address.
+ * @param int $network_id ID of the network.
+ */
+function wp_network_admin_email_change_notification( $option_name, $new_email, $old_email, $network_id ) {
+ $send = true;
+
+ // Don't send the notification to the default 'admin_email' value.
+ if ( 'you@example.com' === $old_email ) {
+ $send = false;
}
- $site_results = $wpdb->get_results( $query, ARRAY_A );
+ /**
+ * Filters whether to send the network admin email change notification email.
+ *
+ * @since 4.9.0
+ *
+ * @param bool $send Whether to send the email notification.
+ * @param string $old_email The old network admin email address.
+ * @param string $new_email The new network admin email address.
+ * @param int $network_id ID of the network.
+ */
+ $send = apply_filters( 'send_network_admin_email_change_email', $send, $old_email, $new_email, $network_id );
+
+ if ( ! $send ) {
+ return;
+ }
+
+ /* translators: Do not translate OLD_EMAIL, NEW_EMAIL, SITENAME, SITEURL: those are placeholders. */
+ $email_change_text = __( 'Hi,
+
+This notice confirms that the network admin email address was changed on ###SITENAME###.
+
+The new network admin email address is ###NEW_EMAIL###.
+
+This email has been sent to ###OLD_EMAIL###
+
+Regards,
+All at ###SITENAME###
+###SITEURL###' );
- return $site_results;
+ $email_change_email = array(
+ 'to' => $old_email,
+ /* translators: Network admin email change notification email subject. %s: Network title */
+ 'subject' => __( '[%s] Notice of Network Admin Email Change' ),
+ 'message' => $email_change_text,
+ 'headers' => '',
+ );
+ // get network name
+ $network_name = wp_specialchars_decode( get_site_option( 'site_name' ), ENT_QUOTES );
+
+ /**
+ * Filters the contents of the email notification sent when the network admin email address is changed.
+ *
+ * @since 4.9.0
+ *
+ * @param array $email_change_email {
+ * Used to build wp_mail().
+ *
+ * @type string $to The intended recipient.
+ * @type string $subject The subject of the email.
+ * @type string $message The content of the email.
+ * The following strings have a special meaning and will get replaced dynamically:
+ * - ###OLD_EMAIL### The old network admin email address.
+ * - ###NEW_EMAIL### The new network admin email address.
+ * - ###SITENAME### The name of the network.
+ * - ###SITEURL### The URL to the site.
+ * @type string $headers Headers.
+ * }
+ * @param string $old_email The old network admin email address.
+ * @param string $new_email The new network admin email address.
+ * @param int $network_id ID of the network.
+ */
+ $email_change_email = apply_filters( 'network_admin_email_change_email', $email_change_email, $old_email, $new_email, $network_id );
+
+ $email_change_email['message'] = str_replace( '###OLD_EMAIL###', $old_email, $email_change_email['message'] );
+ $email_change_email['message'] = str_replace( '###NEW_EMAIL###', $new_email, $email_change_email['message'] );
+ $email_change_email['message'] = str_replace( '###SITENAME###', $network_name, $email_change_email['message'] );
+ $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
+
+ wp_mail( $email_change_email['to'], sprintf(
+ $email_change_email['subject'],
+ $network_name
+ ), $email_change_email['message'], $email_change_email['headers'] );
}