X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..073c5ed6408e2f00dc1863b463fe205467628905:/wp-includes/ms-functions.php diff --git a/wp-includes/ms-functions.php b/wp-includes/ms-functions.php index fd92b2c5..3f5ee2c9 100644 --- a/wp-includes/ms-functions.php +++ b/wp-includes/ms-functions.php @@ -11,8 +11,6 @@ * Gets the network's site and user counts. * * @since MU 1.0 - * @uses get_blog_count() - * @uses get_user_count() * * @return array Site and user count for the network. */ @@ -25,51 +23,27 @@ function get_sitestats() { return $stats; } -/** - * 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 she has one and + * Returns the user's primary blog, if they have one and * it is active. If it's inactive, function returns another * active blog of the user. If none are found, the user * is added as a Subscriber to the Dashboard Blog and that blog * is returned. * * @since MU 1.0 - * @uses get_blogs_of_user() - * @uses add_user_to_blog() - * @uses get_blog_details() + * + * @global wpdb $wpdb WordPress database abstraction object. * * @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]; @@ -108,7 +82,7 @@ function get_active_blog_for_user( $user_id ) { } } } else { - return null; + return; } return $ret; } else { @@ -141,7 +115,7 @@ function get_user_count() { */ function get_blog_count( $network_id = 0 ) { if ( func_num_args() ) - _deprecated_argument( __FUNCTION__, '3.1' ); + _deprecated_argument( __FUNCTION__, '3.1.0' ); return get_site_option( 'blog_count' ); } @@ -164,17 +138,16 @@ function get_blog_post( $blog_id, $post_id ) { } /** - * 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 * - * @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); @@ -194,8 +167,18 @@ function add_user_to_blog( $blog_id, $user_id, $role ) { $user->set_role($role); - do_action('add_user_to_blog', $user_id, $role, $blog_id); + /** + * Fires immediately after a user is added to a site. + * + * @since MU + * + * @param int $user_id User ID. + * @param string $role User role. + * @param int $blog_id Blog ID. + */ + 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; } @@ -203,24 +186,34 @@ function add_user_to_blog( $blog_id, $user_id, $role ) { /** * 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 * - * @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. + * @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 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; switch_to_blog($blog_id); $user_id = (int) $user_id; - do_action('remove_user_from_blog', $user_id, $blog_id); + /** + * Fires before a user is removed from a site. + * + * @since MU + * + * @param int $user_id User ID. + * @param int $blog_id Blog ID. + */ + do_action( 'remove_user_from_blog', $user_id, $blog_id ); // If being removed from the primary blog, set a new primary if the user is assigned // to multiple blogs. @@ -258,47 +251,23 @@ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') { if ( $reassign != '' ) { $reassign = (int) $reassign; - $wpdb->query( $wpdb->prepare("UPDATE $wpdb->posts SET post_author = %d WHERE post_author = %d", $reassign, $user_id) ); - $wpdb->query( $wpdb->prepare("UPDATE $wpdb->links SET link_owner = %d WHERE link_owner = %d", $reassign, $user_id) ); - } - - restore_current_blog(); - - return true; -} - -/** - * Create an empty blog. - * - * @since MU 1.0 - * @uses install_blog() - * - * @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 = '/'; + $post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d", $user_id ) ); + $link_ids = $wpdb->get_col( $wpdb->prepare( "SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $user_id ) ); - // 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 ( ! empty( $post_ids ) ) { + $wpdb->query( $wpdb->prepare( "UPDATE $wpdb->posts SET post_author = %d WHERE post_author = %d", $reassign, $user_id ) ); + array_walk( $post_ids, 'clean_post_cache' ); + } - if ( ! $blog_id = insert_blog($domain, $path, $site_id) ) - return __( 'ERROR: problem creating site entry.' ); + if ( ! empty( $link_ids ) ) { + $wpdb->query( $wpdb->prepare( "UPDATE $wpdb->links SET link_owner = %d WHERE link_owner = %d", $reassign, $user_id ) ); + array_walk( $link_ids, 'clean_bookmark_cache' ); + } + } - switch_to_blog($blog_id); - install_blog($blog_id); restore_current_blog(); - return $blog_id; + return true; } /** @@ -328,13 +297,13 @@ function get_blog_permalink( $blog_id, $post_id ) { * * @since MU 2.6.5 * + * @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' ); @@ -344,7 +313,13 @@ function get_blog_id_from_url( $domain, $path = '/' ) { 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', + ); + $result = get_sites( $args ); + $id = array_shift( $result ); if ( ! $id ) { wp_cache_set( md5( $domain . $path ), -1, 'blog-id-cache' ); @@ -401,30 +376,34 @@ function is_email_address_unsafe( $user_email ) { } } + /** + * Filters whether an email address is unsafe. + * + * @since 3.5.0 + * + * @param bool $is_email_address_unsafe Whether the email address is "unsafe". Default false. + * @param string $user_email User email address. + */ return apply_filters( 'is_email_address_unsafe', $is_email_address_unsafe, $user_email ); } /** - * Processes new user registrations. + * Sanitize and validate data required for a user sign-up. * - * Checks the data provided by the user during signup. Verifies - * the validity and uniqueness of user names and user email addresses, - * and checks email addresses against admin-provided domain - * whitelists and blacklists. + * Verifies the validity and uniqueness of user names and user email addresses, + * and checks email addresses against admin-provided domain whitelists and blacklists. * - * The hook 'wpmu_validate_user_signup' provides an easy way - * to modify the signup process. The value $result, which is passed - * to the hook, contains both the user-provided info and the error - * messages created by the function. 'wpmu_validate_user_signup' allows - * you to process the data in any way you'd like, and unset the - * relevant errors if necessary. + * The {@see 'wpmu_validate_user_signup'} hook provides an easy way to modify the sign-up + * process. The value $result, which is passed to the hook, contains both the user-provided + * info and the error messages created by the function. {@see 'wpmu_validate_user_signup'} + * allows you to process the data in any way you'd like, and unset the relevant errors if + * necessary. * * @since MU - * @uses is_email_address_unsafe() - * @uses username_exists() - * @uses email_exists() * - * @param string $user_name The login name provided by the user. + * @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. * @return array Contains username, email, and error messages. */ @@ -437,7 +416,7 @@ function wpmu_validate_user_signup($user_name, $user_email) { $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; } @@ -447,12 +426,20 @@ function wpmu_validate_user_signup($user_name, $user_email) { $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 ( in_array( strtolower( $user_name ), array_map( 'strtolower', $illegal_logins ) ) ) { + $errors->add( 'user_name', __( 'Sorry, that username is not allowed.' ) ); + } 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.')); @@ -460,8 +447,9 @@ function wpmu_validate_user_signup($user_name, $user_email) { 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 ) ) @@ -471,10 +459,11 @@ function wpmu_validate_user_signup($user_name, $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. @@ -510,7 +499,24 @@ function wpmu_validate_user_signup($user_name, $user_email) { $result = array('user_name' => $user_name, 'orig_username' => $orig_username, 'user_email' => $user_email, 'errors' => $errors); - return apply_filters('wpmu_validate_user_signup', $result); + /** + * 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 + * + * @param array $result { + * The array of user name, email and the error messages. + * + * @type string $user_name Sanitized and unique username. + * @type string $orig_username Original username. + * @type string $user_email User email address. + * @type WP_Error $errors WP_Error object containing any errors found. + * } + */ + return apply_filters( 'wpmu_validate_user_signup', $result ); } /** @@ -524,24 +530,26 @@ function wpmu_validate_user_signup($user_name, $user_email) { * $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 - * @uses domain_exists() - * @uses username_exists() * - * @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; +function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) { + global $wpdb, $domain; + $current_site = get_current_site(); $base = $current_site->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' ); @@ -550,25 +558,27 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { add_site_option( 'illegal_names', $illegal_names ); } - // On sub dir installs, Some names are so illegal, only a filter can spring them from jail - if (! is_subdomain_install() ) - $illegal_names = array_merge($illegal_names, apply_filters( 'subdirectory_reserved_names', array( 'page', 'comments', 'blog', 'files', 'feed' ) ) ); + /* + * On sub dir installs, some names are so illegal, only a filter can + * spring them from jail. + */ + if ( ! is_subdomain_install() ) { + $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.' ) ); - if ( strpos( $blogname, '_' ) !== false ) - $errors->add( 'blogname', __( 'Sorry, site names may not contain the character “_”!' ) ); - // 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 ) ) ) $errors->add( 'blogname', __( 'Sorry, you may not use that site name.' ) ); @@ -577,6 +587,16 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { if ( preg_match( '/^[0-9]*$/', $blogname ) ) $errors->add('blogname', __('Sorry, site names must have letters too!')); + /** + * 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 + * + * @param string $blogname Site name. + */ $blogname = apply_filters( 'newblogname', $blogname ); $blog_title = wp_unslash( $blog_title ); @@ -596,7 +616,7 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { $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!' ) ); } @@ -612,26 +632,44 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { } $result = array('domain' => $mydomain, 'path' => $path, 'blogname' => $blogname, 'blog_title' => $blog_title, 'user' => $user, 'errors' => $errors); - return apply_filters('wpmu_validate_blog_signup', $result); + + /** + * Filters site details and error messages following registration. + * + * @since MU + * + * @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|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 ); } /** * Record site signup information for future activation. * * @since MU - * @uses wpmu_signup_blog_notification() * - * @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. + * @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 $user_email The user's email address. - * @param array $meta By default, contains the requested privacy setting and lang_id. + * @param array $meta 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 ); + $key = substr( md5( time() . wp_rand() . $domain ), 0, 16 ); $meta = serialize($meta); $wpdb->insert( $wpdb->signups, array( @@ -645,7 +683,20 @@ function wpmu_signup_blog( $domain, $path, $title, $user, $user_email, $meta = a 'meta' => $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 By default, contains the requested privacy setting and lang_id. + */ + do_action( 'after_signup_site', $domain, $path, $title, $user, $user_email, $key, $meta ); } /** @@ -655,11 +706,12 @@ function wpmu_signup_blog( $domain, $path, $title, $user, $user_email, $meta = a * new site registration is not. * * @since MU - * @uses wpmu_signup_user_notification() * - * @param string $user The user's requested login name. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @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 By default, this is an empty array. */ function wpmu_signup_user( $user, $user_email, $meta = array() ) { global $wpdb; @@ -667,7 +719,7 @@ function wpmu_signup_user( $user, $user_email, $meta = array() ) { // 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 ); + $key = substr( md5( time() . wp_rand() . $user_email ), 0, 16 ); $meta = serialize($meta); $wpdb->insert( $wpdb->signups, array( @@ -681,7 +733,17 @@ function wpmu_signup_user( $user, $user_email, $meta = array() ) { 'meta' => $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 Additional signup meta. By default, this is an empty array. + */ + do_action( 'after_signup_user', $user, $user_email, $key, $meta ); } /** @@ -690,32 +752,44 @@ function wpmu_signup_user( $user, $user_email, $meta = array() ) { * 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 * - * @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 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 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() ) { - global $current_site; - - if ( !apply_filters('wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta) ) + /** + * Filters whether to bypass the new site email notification. + * + * @since MU + * + * @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_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. + */ + if ( ! apply_filters( 'wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta ) ) { return false; + } // Send email with activation link. - if ( !is_subdomain_install() || $current_site->id != 1 ) + if ( !is_subdomain_install() || get_current_site()->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 @@ -727,6 +801,22 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema $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"; $message = sprintf( + /** + * Filters the message content of the new blog notification email. + * + * Content should be formatted for transmission via wp_mail(). + * + * @since MU + * + * @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_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. + */ 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 @@ -737,6 +827,20 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema ); // TODO: Don't hard code activation link. $subject = sprintf( + /** + * Filters the subject of the new blog notification email. + * + * @since MU + * + * @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_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. + */ apply_filters( 'wpmu_signup_blog_notification_subject', __( '[%1$s] Activate %2$s' ), $domain, $path, $title, $user, $user_email, $key, $meta @@ -744,7 +848,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema $from_name, esc_url( 'http://' . $domain . $path ) ); - wp_mail($user_email, $subject, $message, $message_headers); + wp_mail( $user_email, wp_specialchars_decode( $subject ), $message, $message_headers ); return true; } @@ -754,23 +858,33 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema * 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 * - * @param string $user The user's login name. + * @param string $user 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 By default, an empty array. * @return bool */ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) { - if ( !apply_filters('wpmu_signup_user_notification', $user, $user_email, $key, $meta) ) + /** + * Filters whether to bypass the email notification for new user sign-up. + * + * @since MU + * + * @param string $user 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. + */ + if ( ! apply_filters( 'wpmu_signup_user_notification', $user, $user_email, $key, $meta ) ) return false; // Send email with activation link. @@ -780,6 +894,19 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array( $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"; $message = sprintf( + /** + * Filters the content of the notification email for new user sign-up. + * + * Content should be formatted for transmission via wp_mail(). + * + * @since MU + * + * @param string $content Content of the notification email. + * @param string $user 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. + */ 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 @@ -788,6 +915,17 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array( ); // TODO: Don't hard code activation link. $subject = sprintf( + /** + * Filters the subject of the notification email of new user signup. + * + * @since MU + * + * @param string $subject Subject of the notification email. + * @param string $user 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. + */ apply_filters( 'wpmu_signup_user_notification_subject', __( '[%1$s] Activate %2$s' ), $user, $user_email, $key, $meta @@ -795,28 +933,24 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array( $from_name, $user ); - wp_mail($user_email, $subject, $message, $message_headers); + wp_mail( $user_email, wp_specialchars_decode( $subject ), $message, $message_headers ); 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 - * @uses wp_generate_password() - * @uses wpmu_welcome_user_notification() - * @uses add_user_to_blog() - * @uses wpmu_create_user() - * @uses wpmu_create_blog() - * @uses wpmu_welcome_notification() + * + * @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; @@ -854,7 +988,15 @@ function wpmu_activate_signup($key) { 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 + * + * @param int $user_id User ID. + * @param int $password User password. + * @param array $meta Signup meta data. + */ do_action( 'wpmu_activate_user', $user_id, $password, $meta ); return array( 'user_id' => $user_id, 'password' => $password, 'meta' => $meta ); } @@ -873,8 +1015,18 @@ function wpmu_activate_signup($key) { } $wpdb->update( $wpdb->signups, array('active' => 1, 'activated' => $now), array('activation_key' => $key) ); - wpmu_welcome_notification($blog_id, $user_id, $password, $signup->title, $meta); - do_action('wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta); + /** + * Fires immediately after a site is activated. + * + * @since MU + * + * @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. + */ + do_action( 'wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta ); return array('blog_id' => $blog_id, 'user_id' => $user_id, 'password' => $password, 'title' => $signup->title, 'meta' => $meta); } @@ -883,17 +1035,16 @@ function wpmu_activate_signup($key) { * 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 - * @uses wp_create_user() * * @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 mixed 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 ) ); @@ -906,6 +1057,13 @@ function wpmu_create_user( $user_name, $password, $email ) { delete_user_option( $user_id, 'capabilities' ); delete_user_option( $user_id, 'user_level' ); + /** + * Fires immediately after a new user is created. + * + * @since MU + * + * @param int $user_id User ID. + */ do_action( 'wpmu_new_user', $user_id ); return $user_id; @@ -915,7 +1073,7 @@ function wpmu_create_user( $user_name, $password, $email ) { * 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 @@ -924,18 +1082,14 @@ function wpmu_create_user( $user_name, $password, $email ) { * root domain (eg 'blog1.example.com'), and $path is '/'. * * @since MU - * @uses domain_exists() - * @uses insert_blog() - * @uses wp_install_defaults() - * @uses add_user_to_blog() - * - * @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. Used to set initial site options. + * @param int $site_id Optional. Only relevant on multi-network installs. + * @return int|WP_Error Returns WP_Error object on failure, int $blog_id on success */ function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $site_id = 1 ) { $defaults = array( 'public' => 0 ); @@ -956,8 +1110,9 @@ function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $s if ( domain_exists($domain, $path, $site_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) ) return new WP_Error('insert_blog', __('Could not create site.')); @@ -982,20 +1137,35 @@ function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $s update_user_meta( $user_id, 'primary_blog', $blog_id ); restore_current_blog(); + /** + * Fires immediately after a new site is created. + * + * @since MU + * + * @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. + */ do_action( 'wpmu_new_blog', $blog_id, $user_id, $domain, $path, $site_id, $meta ); + wp_cache_set( 'last_changed', microtime(), 'sites' ); + return $blog_id; } /** * 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 * - * @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 = '' ) { @@ -1018,6 +1188,14 @@ URL: %2$s Remote IP: %3$s Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url); + /** + * Filters the message body of the new site activation email sent + * to the network administrator. + * + * @since MU + * + * @param string $msg Email body. + */ $msg = apply_filters( 'newblog_notify_siteadmin', $msg ); wp_mail( $email, sprintf( __( 'New Site Registration: %s' ), $siteurl ), $msg ); @@ -1027,11 +1205,10 @@ Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER[ /** * 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 - * @uses apply_filters() Filter newuser_notify_siteadmin to change the content of the email message * * @param int $user_id The new user's ID. * @return bool @@ -1053,6 +1230,15 @@ Remote IP: %2$s Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url); + /** + * Filters the message body of the new user activation email sent + * to the network administrator. + * + * @since MU + * + * @param string $msg Email body. + * @param WP_User $user WP_User instance of the new user. + */ $msg = apply_filters( 'newuser_notify_siteadmin', $msg, $user ); wp_mail( $email, sprintf(__('New User Registration: %s'), $user->user_login), $msg ); return true; @@ -1066,14 +1252,34 @@ Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['RE * * @since MU * - * @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. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @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 */ function domain_exists($domain, $path, $site_id = 1) { - global $wpdb; - $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) ); + $path = trailingslashit( $path ); + $args = array( + 'network_id' => $site_id, + 'domain' => $domain, + 'path' => $path, + 'fields' => 'ids', + ); + $result = get_sites( $args ); + $result = array_shift( $result ); + + /** + * Filters whether a blogname is taken. + * + * @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. + */ return apply_filters( 'domain_exists', $result, $domain, $path, $site_id ); } @@ -1085,10 +1291,12 @@ function domain_exists($domain, $path, $site_id = 1) { * * @since MU * - * @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 + * @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|false The ID of the new row */ function insert_blog($domain, $path, $site_id) { global $wpdb; @@ -1116,13 +1324,14 @@ function insert_blog($domain, $path, $site_id) { * points to the new blog. * * @since MU - * @uses make_db_current_silent() - * @uses populate_roles() * - * @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 = '') { +function install_blog( $blog_id, $blog_title = '' ) { global $wpdb, $wp_roles, $current_site; // Cast for security @@ -1130,10 +1339,10 @@ function install_blog($blog_id, $blog_title = '') { require_once( ABSPATH . 'wp-admin/includes/upgrade.php' ); - $wpdb->suppress_errors(); + $suppress = $wpdb->suppress_errors(); if ( $wpdb->get_results( "DESCRIBE {$wpdb->posts}" ) ) die( '
' . __( 'You appear to have already installed WordPress. To reinstall please clear your old database tables first.' ) . '