X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/a6f44f0edcda2471c5a33e4156c1c9488c7f3210..784f914b1e4b1c62d6657e86397c2e83bcee4295:/wp-includes/ms-functions.php diff --git a/wp-includes/ms-functions.php b/wp-includes/ms-functions.php index 9f8c31a8..dfb25daa 100644 --- a/wp-includes/ms-functions.php +++ b/wp-includes/ms-functions.php @@ -11,14 +11,10 @@ * 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. */ function get_sitestats() { - global $wpdb; - $stats = array( 'blogs' => get_blog_count(), 'users' => get_user_count(), @@ -27,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]; @@ -110,7 +82,7 @@ function get_active_blog_for_user( $user_id ) { } } } else { - return null; + return; } return $ret; } else { @@ -138,10 +110,13 @@ function get_user_count() { * * @since MU 1.0 * - * @param int $id Optional. A site_id. + * @param int $network_id Deprecated, not supported. * @return int */ -function get_blog_count( $id = 0 ) { +function get_blog_count( $network_id = 0 ) { + if ( func_num_args() ) + _deprecated_argument( __FUNCTION__, '3.1' ); + return get_site_option( 'blog_count' ); } @@ -170,10 +145,10 @@ function get_blog_post( $blog_id, $post_id ) { * * @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); @@ -193,8 +168,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; } @@ -210,16 +195,26 @@ function add_user_to_blog( $blog_id, $user_id, $role ) { * * @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. @@ -257,47 +252,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; -} + $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 ) ); -/** - * 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 = '/'; - - // 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; } /** @@ -327,8 +298,10 @@ 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 = '/' ) { @@ -400,30 +373,34 @@ function is_email_address_unsafe( $user_email ) { } } + /** + * Filter 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. */ @@ -436,7 +413,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; } @@ -446,12 +423,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.')); @@ -459,8 +444,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 ) ) @@ -470,10 +456,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. @@ -509,7 +496,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); + /** + * Filter 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 ); } /** @@ -527,20 +531,22 @@ function wpmu_validate_user_signup($user_name, $user_email) { * 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' ); @@ -549,25 +555,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.' ) ); @@ -576,6 +584,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!')); + /** + * Filter 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 ); @@ -595,7 +613,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!' ) ); } @@ -611,23 +629,41 @@ 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); + + /** + * Filter 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 = '') { +function wpmu_signup_blog( $domain, $path, $title, $user, $user_email, $meta = array() ) { global $wpdb; $key = substr( md5( time() . rand() . $domain ), 0, 16 ); @@ -644,7 +680,20 @@ function wpmu_signup_blog($domain, $path, $title, $user, $user_email, $meta = '' '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 ); } /** @@ -654,13 +703,14 @@ function wpmu_signup_blog($domain, $path, $title, $user, $user_email, $meta = '' * 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 = '') { +function wpmu_signup_user( $user, $user_email, $meta = array() ) { global $wpdb; // Format data @@ -680,7 +730,17 @@ function wpmu_signup_user($user, $user_email, $meta = '') { '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 ); } /** @@ -698,23 +758,35 @@ function wpmu_signup_user($user, $user_email, $meta = '') { * * @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 array $meta By default, contains the requested privacy setting and lang_id. - * @param string $key The activation key created in wpmu_signup_blog() + * @param string $key The activation key created in wpmu_signup_blog() + * @param array $meta 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 = '') { - global $current_site; - - if ( !apply_filters('wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta) ) +function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_email, $key, $meta = array() ) { + /** + * Filter 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 @@ -726,6 +798,22 @@ function wpmu_signup_blog_notification($domain, $path, $title, $user, $user_emai $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( + /** + * Filter 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 @@ -736,6 +824,20 @@ function wpmu_signup_blog_notification($domain, $path, $title, $user, $user_emai ); // TODO: Don't hard code activation link. $subject = sprintf( + /** + * Filter 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 @@ -743,7 +845,7 @@ function wpmu_signup_blog_notification($domain, $path, $title, $user, $user_emai $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; } @@ -762,14 +864,24 @@ function wpmu_signup_blog_notification($domain, $path, $title, $user, $user_emai * * @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 array $meta By default, an empty array. - * @param string $key The activation key created in wpmu_signup_user() + * @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 = '') { - if ( !apply_filters('wpmu_signup_user_notification', $user, $user_email, $key, $meta) ) +function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) { + /** + * Filter 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. @@ -779,6 +891,19 @@ function wpmu_signup_user_notification($user, $user_email, $key, $meta = '') { $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( + /** + * Filter 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 @@ -787,6 +912,17 @@ function wpmu_signup_user_notification($user, $user_email, $key, $meta = '') { ); // TODO: Don't hard code activation link. $subject = sprintf( + /** + * Filter 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 @@ -794,7 +930,7 @@ function wpmu_signup_user_notification($user, $user_email, $key, $meta = '') { $from_name, $user ); - wp_mail($user_email, $subject, $message, $message_headers); + wp_mail( $user_email, wp_specialchars_decode( $subject ), $message, $message_headers ); return true; } @@ -807,18 +943,14 @@ function wpmu_signup_user_notification($user, $user_email, $key, $meta = '') { * 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, $current_site; + global $wpdb; $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE activation_key = %s", $key) ); @@ -853,7 +985,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 ); } @@ -872,8 +1012,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); } @@ -887,12 +1037,11 @@ function wpmu_activate_signup($key) { * use '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 ) ); @@ -905,6 +1054,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; @@ -923,20 +1079,19 @@ 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 - */ -function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id = 1) { + * + * @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 ); + $meta = wp_parse_args( $meta, $defaults ); + $domain = preg_replace( '/\s+/', '', sanitize_user( $domain, true ) ); if ( is_subdomain_install() ) @@ -952,8 +1107,9 @@ function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id 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.')); @@ -964,20 +1120,32 @@ function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id add_user_to_blog($blog_id, $user_id, 'administrator'); - if ( is_array($meta) ) foreach ($meta as $key => $value) { - if ( $key == 'public' || $key == 'archived' || $key == 'mature' || $key == 'spam' || $key == 'deleted' || $key == 'lang_id' ) + foreach ( $meta as $key => $value ) { + if ( in_array( $key, array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ) ) ) update_blog_status( $blog_id, $key, $value ); else update_option( $key, $value ); } add_option( 'WPLANG', get_site_option( 'WPLANG' ) ); - update_option( 'blog_public', (int)$meta['public'] ); + update_option( 'blog_public', (int) $meta['public'] ); if ( ! is_super_admin( $user_id ) && ! get_user_meta( $user_id, 'primary_blog', true ) ) 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 ); return $blog_id; @@ -991,7 +1159,8 @@ function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id * * @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 = '' ) { @@ -1014,6 +1183,14 @@ URL: %2$s Remote IP: %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 + * 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,7 +1204,6 @@ Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER[ * 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 @@ -1049,6 +1225,15 @@ Remote IP: %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 + * 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; @@ -1062,14 +1247,28 @@ 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; + $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) ); + + /** + * Filter 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 ); } @@ -1081,10 +1280,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; @@ -1098,6 +1299,9 @@ function insert_blog($domain, $path, $site_id) { $blog_id = $wpdb->insert_id; refresh_blog_details( $blog_id ); + + wp_maybe_update_network_site_counts(); + return $blog_id; } @@ -1109,13 +1313,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 @@ -1123,10 +1328,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( '

' . __( 'Already Installed' ) . '

' . __( 'You appear to have already installed WordPress. To reinstall please clear your old database tables first.' ) . '

' ); - $wpdb->suppress_errors( false ); + $wpdb->suppress_errors( $suppress ); $url = get_blogaddress_by_id( $blog_id ); @@ -1134,17 +1339,30 @@ function install_blog($blog_id, $blog_title = '') { make_db_current_silent( 'blog' ); populate_options(); populate_roles(); - $wp_roles->_init(); - $url = untrailingslashit( $url ); + // populate_roles() clears previous role definitions so we start over. + $wp_roles = new WP_Roles(); - update_option( 'siteurl', $url ); - update_option( 'home', $url ); + $siteurl = $home = untrailingslashit( $url ); + + if ( ! is_subdomain_install() ) { + + if ( 'https' === parse_url( get_site_option( 'siteurl' ), PHP_URL_SCHEME ) ) { + $siteurl = set_url_scheme( $siteurl, 'https' ); + } + if ( 'https' === parse_url( get_home_url( $current_site->blog_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( $current_site->blog_id, 'upload_path' ) ); + update_option( 'upload_path', get_blog_option( get_current_site()->blog_id, 'upload_path' ) ); update_option( 'blogname', wp_unslash( $blog_title ) ); update_option( 'admin_email', '' ); @@ -1163,7 +1381,8 @@ function install_blog($blog_id, $blog_title = '') { * @since MU * @deprecated MU * @deprecated Use wp_install_defaults() - * @uses wp_install_defaults() + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $blog_id Ignored in this function. * @param int $user_id @@ -1173,15 +1392,15 @@ function install_blog_defaults($blog_id, $user_id) { require_once( ABSPATH . 'wp-admin/includes/upgrade.php' ); - $wpdb->suppress_errors(); + $suppress = $wpdb->suppress_errors(); wp_install_defaults($user_id); - $wpdb->suppress_errors( false ); + $wpdb->suppress_errors( $suppress ); } /** - * Notify a user that her blog activation has been successful. + * Notify a user that their blog activation has been successful. * * Filter 'wpmu_welcome_notification' to disable or bypass. * @@ -1190,27 +1409,42 @@ function install_blog_defaults($blog_id, $user_id) { * * @since MU * - * @param int $blog_id - * @param int $user_id + * @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 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. * @return bool */ -function wpmu_welcome_notification($blog_id, $user_id, $password, $title, $meta = '') { - global $current_site; - - if ( !apply_filters('wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta) ) +function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) { + $current_site = get_current_site(); + + /** + * Filter whether to bypass the welcome email after site activation. + * + * Returning false disables the welcome email. + * + * @since MU + * + * @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. + */ + if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) ) return false; $welcome_email = get_site_option( 'welcome_email' ); - if ( $welcome_email == false ) - $welcome_email = __( 'Dear User, + 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: BLOG_URL You can log in to the administrator account with the following information: + Username: USERNAME Password: PASSWORD Log in here: BLOG_URLwp-login.php @@ -1218,6 +1452,7 @@ Log in here: BLOG_URLwp-login.php We hope you enjoy your new site. Thanks! --The Team @ SITE_NAME' ); + } $url = get_blogaddress_by_id($blog_id); $user = get_userdata( $user_id ); @@ -1228,7 +1463,21 @@ We hope you enjoy your new site. Thanks! $welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email ); $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email ); - $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta); + /** + * Filter the content of the welcome email after site activation. + * + * Content should be formatted for transmission via wp_mail(). + * + * @since MU + * + * @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. + */ + $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta ); $admin_email = get_site_option( 'admin_email' ); if ( $admin_email == '' ) @@ -1241,13 +1490,20 @@ We hope you enjoy your new site. Thanks! if ( empty( $current_site->site_name ) ) $current_site->site_name = 'WordPress'; - $subject = apply_filters( 'update_welcome_subject', sprintf(__('New %1$s Site: %2$s'), $current_site->site_name, wp_unslash( $title ) ) ); - wp_mail($user->user_email, $subject, $message, $message_headers); + /** + * Filter the subject of the welcome email after site activation. + * + * @since MU + * + * @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 ) ) ); + wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $message, $message_headers ); return true; } /** - * Notify a user that her account activation has been successful. + * Notify a user that their account activation has been successful. * * Filter 'wpmu_welcome_user_notification' to disable or bypass. * @@ -1256,22 +1512,45 @@ We hope you enjoy your new site. Thanks! * * @since MU * - * @param int $user_id + * @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 array $meta Optional. Not used in the default function, but is passed along to hooks for customization. * @return bool */ -function wpmu_welcome_user_notification($user_id, $password, $meta = '') { - global $current_site; - - if ( !apply_filters('wpmu_welcome_user_notification', $user_id, $password, $meta) ) +function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) { + $current_site = get_current_site(); + + /** + * Filter whether to bypass the welcome email after user activation. + * + * Returning false disables the welcome email. + * + * @since MU + * + * @param int $user_id User ID. + * @param string $password User password. + * @param array $meta Signup meta data. + */ + if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) ) return false; $welcome_email = get_site_option( 'welcome_user_email' ); $user = get_userdata( $user_id ); - $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta); + /** + * Filters the content of the welcome email after user activation. + * + * Content should be formatted for transmission via wp_mail(). + * + * @since MU + * + * @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. + */ + $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( 'USERNAME', $user->user_login, $welcome_email ); $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email ); @@ -1289,20 +1568,31 @@ function wpmu_welcome_user_notification($user_id, $password, $meta = '') { if ( empty( $current_site->site_name ) ) $current_site->site_name = 'WordPress'; - $subject = apply_filters( 'update_welcome_user_subject', sprintf(__('New %1$s User: %2$s'), $current_site->site_name, $user->user_login) ); - wp_mail($user->user_email, $subject, $message, $message_headers); + /** + * Filter the subject of the welcome email after user activation. + * + * @since MU + * + * @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) ); + wp_mail( $user->user_email, wp_specialchars_decode( $subject ), $message, $message_headers ); 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 network being viewed. * - * Returns an object containing the ID, domain, path, and site_name - * of the site being viewed. + * @see wpmu_current_site() * * @since MU * - * @return object + * @global WP_Network $current_site + * + * @return WP_Network */ function get_current_site() { global $current_site; @@ -1316,7 +1606,8 @@ function get_current_site() { * the most recent post_date_gmt. * * @since MU - * @uses get_blogs_of_user() + * + * @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 @@ -1363,20 +1654,25 @@ function get_most_recent_post_of_user( $user_id ) { * a blog has exceeded its allowed upload space. * * @since MU - * @uses recurse_dirsize() * - * @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' ]; @@ -1389,17 +1685,20 @@ function get_dirsize( $directory ) { * other directories. * * @since MU + * @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) { @@ -1408,7 +1707,7 @@ function recurse_dirsize( $directory ) { 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; } @@ -1434,7 +1733,8 @@ function recurse_dirsize( $directory ) { * @return array */ function check_upload_mimes( $mimes ) { - $site_exts = explode( ' ', get_site_option( 'upload_filetypes' ) ); + $site_exts = explode( ' ', get_site_option( 'upload_filetypes', 'jpg jpeg png gif' ) ); + $site_mimes = array(); foreach ( $site_exts as $ext ) { foreach ( $mimes as $ext_pattern => $mime ) { if ( $ext != '' && strpos( $ext_pattern, $ext ) !== false ) @@ -1450,9 +1750,13 @@ function check_upload_mimes( $mimes ) { * 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 to make sure the count stays current. + * are published or unpublished to make sure the count stays current. * * @since MU + * + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param string $deprecated Not used. */ function update_posts_count( $deprecated = '' ) { global $wpdb; @@ -1464,13 +1768,16 @@ function update_posts_count( $deprecated = '' ) { * * @since MU * + * @global wpdb $wpdb WordPress database abstraction object. + * * @param int $blog_id * @param int $user_id */ function wpmu_log_new_registrations( $blog_id, $user_id ) { global $wpdb; $user = get_userdata( (int) $user_id ); - $wpdb->insert( $wpdb->registration_log, array('email' => $user->user_email, 'IP' => preg_replace( '/[^0-9., ]/', '', wp_unslash( $_SERVER['REMOTE_ADDR'] ) ), 'blog_id' => $blog_id, 'date_registered' => current_time('mysql')) ); + if ( $user ) + $wpdb->insert( $wpdb->registration_log, array('email' => $user->user_email, 'IP' => preg_replace( '/[^0-9., ]/', '', wp_unslash( $_SERVER['REMOTE_ADDR'] ) ), 'blog_id' => $blog_id, 'date_registered' => current_time('mysql')) ); } /** @@ -1480,7 +1787,11 @@ function wpmu_log_new_registrations( $blog_id, $user_id ) { * * @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 = '' ) { @@ -1518,11 +1829,13 @@ function global_terms( $term_id, $deprecated = '' ) { $global_id = $wpdb->insert_id; } } elseif ( $global_id != $term_id ) { - $local_id = $wpdb->get_row( $wpdb->prepare( "SELECT term_id FROM $wpdb->terms WHERE term_id = %d", $global_id ) ); - if ( null != $local_id ) - $local_id = global_terms( $local_id ); - if ( 10 < $global_terms_recurse ) + $local_id = $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->terms WHERE term_id = %d", $global_id ) ); + if ( null != $local_id ) { + global_terms( $local_id ); + if ( 10 < $global_terms_recurse ) { $global_id = $term_id; + } + } } if ( $global_id != $term_id ) { @@ -1535,7 +1848,7 @@ function global_terms( $term_id, $deprecated = '' ) { clean_term_cache($term_id); } - if( $recurse_start ) + if ( $recurse_start ) $global_terms_recurse = null; return $global_id; @@ -1547,11 +1860,11 @@ function global_terms( $term_id, $deprecated = '' ) { * @see wp_validate_redirect() * @since MU * + * @param array|string $deprecated Not used. * @return array The current site's domain */ function redirect_this_site( $deprecated = '' ) { - global $current_site; - return array( $current_site->domain ); + return array( get_current_site()->domain ); } /** @@ -1559,15 +1872,18 @@ function redirect_this_site( $deprecated = '' ) { * * @since MU * + * @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; } @@ -1576,7 +1892,6 @@ function upload_is_file_too_big( $upload ) { * Add a nonce field to the signup page. * * @since MU - * @uses wp_nonce_field() */ function signup_nonce_fields() { $id = mt_rand(); @@ -1588,7 +1903,6 @@ function signup_nonce_fields() { * Process the signup nonce created in signup_nonce_fields(). * * @since MU - * @uses wp_create_nonce() * * @param array $result * @return array @@ -1609,7 +1923,15 @@ function signup_nonce_check( $result ) { * @since MU */ function maybe_redirect_404() { - global $current_site; + /** + * Filter the redirect URL for 404s on the main site. + * + * The filter is only evaluated if the NOBLOGREDIRECT constant is defined. + * + * @since 3.0.0 + * + * @param string $no_blog_redirect The redirect URL defined in NOBLOGREDIRECT. + */ if ( is_main_site() && is_404() && defined( 'NOBLOGREDIRECT' ) && ( $destination = apply_filters( 'blog_redirect_404', NOBLOGREDIRECT ) ) ) { if ( $destination == '%siteurl%' ) $destination = network_home_url(); @@ -1626,11 +1948,10 @@ function maybe_redirect_404() { * added, as when a user is invited through the regular WP Add User interface. * * @since MU - * @uses add_existing_user_to_blog() */ 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 ); @@ -1645,25 +1966,35 @@ function maybe_add_existing_user_to_blog() { if ( empty( $details ) || is_wp_error( add_existing_user_to_blog( $details ) ) ) wp_die( sprintf(__('An error occurred adding you to this site. Back to the homepage.'), home_url() ) ); - wp_die( sprintf( __( 'You have been added to this site. Please visit the homepage or log in using your username and password.' ), home_url(), admin_url() ), __( 'WordPress › Success' ) ); + wp_die( sprintf( __( 'You have been added to this site. Please visit the homepage or log in using your username and password.' ), home_url(), admin_url() ), __( 'WordPress › Success' ), array( 'response' => 200 ) ); } /** * Add a user to a blog based on details from maybe_add_existing_user_to_blog(). * * @since MU - * @uses add_user_to_blog() + * + * @global int $blog_id * * @param array $details + * @return true|WP_Error|void */ function add_existing_user_to_blog( $details = false ) { global $blog_id; if ( is_array( $details ) ) { $result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] ); - do_action( 'added_existing_user', $details[ 'user_id' ], $result ); + /** + * Fires immediately after an existing user is added to a site. + * + * @since MU + * + * @param int $user_id User ID. + * @param mixed $result True on success or a WP_Error object if the user doesn't exist. + */ + do_action( 'added_existing_user', $details['user_id'], $result ); + return $result; } - return $result; } /** @@ -1675,16 +2006,15 @@ function add_existing_user_to_blog( $details = false ) { * @since MU * @see add_user_to_blog() * - * @param int $user_id + * @param int $user_id * @param mixed $password Ignored. * @param array $meta */ function add_new_user_to_blog( $user_id, $password, $meta ) { - global $current_site; if ( !empty( $meta[ 'add_to_blog' ] ) ) { $blog_id = $meta[ 'add_to_blog' ]; $role = $meta[ 'new_role' ]; - remove_user_from_blog($user_id, $current_site->blog_id); // remove user from main blog. + 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 ); } @@ -1694,26 +2024,30 @@ function add_new_user_to_blog( $user_id, $password, $meta ) { * Correct From host on outgoing mail to match the site domain * * @since MU + * + * @param PHPMailer $phpmailer The PHPMailer instance, passed by reference. */ function fix_phpmailer_messageid( $phpmailer ) { - global $current_site; - $phpmailer->Hostname = $current_site->domain; + $phpmailer->Hostname = get_current_site()->domain; } /** * Check to see whether a user is marked as a spammer, based on user login. * * @since MU - * @uses get_user_by() * - * @param string $user_login Optional. Defaults to current user. + * @param string|WP_User $user Optional. Defaults to current user. WP_User object, + * or user login name as a string. * @return bool */ -function is_user_spammy( $user_login = null ) { - if ( $user_login ) - $user = get_user_by( 'login', $user_login ); - else - $user = wp_get_current_user(); +function is_user_spammy( $user = null ) { + if ( ! ( $user instanceof WP_User ) ) { + if ( $user ) { + $user = get_user_by( 'login', $user ); + } else { + $user = wp_get_current_user(); + } + } return $user && isset( $user->spam ) && 1 == $user->spam; } @@ -1724,58 +2058,36 @@ function is_user_spammy( $user_login = null ) { * Public blogs have a setting of 1, private blogs are 0. * * @since MU - * @uses update_blog_status() * * @param int $old_value - * @param int $value The new public value - * @return bool + * @param int $value The new public value */ function update_blog_public( $old_value, $value ) { update_blog_status( get_current_blog_id(), 'public', (int) $value ); } -add_action('update_option_blog_public', 'update_blog_public', 10, 2); - -/** - * Get the "dashboard blog", the blog where users without a blog edit their profile data. - * - * @since MU - * @uses get_blog_details() - * - * @return int - */ -function get_dashboard_blog() { - if ( $blog = get_site_option( 'dashboard_blog' ) ) - return get_blog_details( $blog ); - - return get_blog_details( $GLOBALS['current_site']->blog_id ); -} /** * Check whether a usermeta key has to do with the current blog. * * @since MU - * @uses wp_get_current_user() + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $key - * @param int $user_id Optional. Defaults to current user. - * @param int $blog_id Optional. Defaults to current blog. + * @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 ( $user_id == 0 ) - $user_id = $current_user->ID; - if ( $blog_id == 0 ) + 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; + return isset( $current_user->$local_key ); } /** @@ -1787,12 +2099,8 @@ function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) { */ 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' ); } -add_filter('option_users_can_register', 'users_can_register_signup_filter'); /** * Ensure that the welcome message is not empty. Currently unused. @@ -1805,7 +2113,9 @@ add_filter('option_users_can_register', 'users_can_register_signup_filter'); function welcome_user_msg_filter( $text ) { if ( !$text ) { remove_filter( 'site_option_welcome_user_email', 'welcome_user_msg_filter' ); - $text = __( 'Dear User, + + /* translators: Do not translate USERNAME, PASSWORD, LOGINLINK, SITE_NAME: those are placeholders. */ + $text = __( 'Howdy USERNAME, Your new account is set up. @@ -1821,18 +2131,19 @@ Thanks! } return $text; } -add_filter( 'site_option_welcome_user_email', 'welcome_user_msg_filter' ); /** * Whether to force SSL on content. * * @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; @@ -1850,7 +2161,7 @@ function force_ssl_content( $force = '' ) { * * @since 2.8.5 * - * @param string URL + * @param string $url URL * @return string URL with https as the scheme */ function filter_SSL( $url ) { @@ -1872,7 +2183,7 @@ function wp_schedule_update_network_counts() { 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'); } @@ -1882,10 +2193,78 @@ function wp_schedule_update_network_counts() { * @since 3.1.0 */ function wp_update_network_counts() { + wp_update_network_user_counts(); + wp_update_network_site_counts(); +} + +/** + * Update the count of sites for the current network. + * + * If enabled through the '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 + */ +function wp_maybe_update_network_site_counts() { + $is_small_network = ! wp_is_large_network( 'sites' ); + + /** + * Filter whether to update network site or user counts when a new site is created. + * + * @since 3.7.0 + * + * @see wp_is_large_network() + * + * @param bool $small_network Whether the network is considered small. + * @param string $context Context. Either 'users' or 'sites'. + */ + if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'sites' ) ) + return; + + wp_update_network_site_counts(); +} + +/** + * Update the network-wide users count. + * + * If enabled through the '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 + */ +function wp_maybe_update_network_user_counts() { + $is_small_network = ! wp_is_large_network( 'users' ); + + /** 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(); +} + +/** + * Update the network-wide site count. + * + * @since 3.7.0 + * + * @global wpdb $wpdb WordPress database abstraction object. + */ +function wp_update_network_site_counts() { global $wpdb; $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 ); +} + +/** + * Update the network-wide user count. + * + * @since 3.7.0 + * + * @global wpdb $wpdb WordPress database abstraction object. + */ +function wp_update_network_user_counts() { + 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 ); @@ -1899,11 +2278,17 @@ function wp_update_network_counts() { * @return int Used space in megabytes */ function get_space_used() { - // Allow for an alternative way of tracking storage space used + /** + * Filter the amount of storage space used by the current site. + * + * @since 3.5.0 + * + * @param int|bool $space_used The amount of used space, in megabytes. Default false. + */ $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; @@ -1922,10 +2307,17 @@ function get_space_allowed() { if ( ! is_numeric( $space_allowed ) ) $space_allowed = get_site_option( 'blog_upload_space' ); - if ( empty( $space_allowed ) || ! is_numeric( $space_allowed ) ) - $space_allowed = 50; - - return $space_allowed; + if ( ! is_numeric( $space_allowed ) ) + $space_allowed = 100; + + /** + * Filter the upload quota for the current site. + * + * @since 3.7.0 + * + * @param int $space_allowed Upload quota in megabytes for the current blog. + */ + return apply_filters( 'get_space_allowed', $space_allowed ); } /** @@ -1936,11 +2328,15 @@ function get_space_allowed() { * @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; @@ -1962,12 +2358,15 @@ function is_upload_space_available() { } /** + * 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 ); @@ -1987,9 +2386,123 @@ function upload_size_limit_filter( $size ) { function wp_is_large_network( $using = 'sites' ) { if ( 'users' == $using ) { $count = get_user_count(); + /** + * Filter whether the network is considered large. + * + * @since 3.3.0 + * + * @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. + */ return apply_filters( 'wp_is_large_network', $count > 10000, 'users', $count ); } $count = get_blog_count(); + /** This filter is documented in wp-includes/ms-functions.php */ return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count ); } + + +/** + * Return an array of sites for a network or networks. + * + * @since 3.7.0 + * + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param array $args { + * Array of default arguments. Optional. + * + * @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. + */ +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) "; + } + + if ( isset( $args['public'] ) ) + $query .= $wpdb->prepare( "AND public = %d ", $args['public'] ); + + if ( isset( $args['archived'] ) ) + $query .= $wpdb->prepare( "AND archived = %d ", $args['archived'] ); + + if ( isset( $args['mature'] ) ) + $query .= $wpdb->prepare( "AND mature = %d ", $args['mature'] ); + + if ( isset( $args['spam'] ) ) + $query .= $wpdb->prepare( "AND spam = %d ", $args['spam'] ); + + if ( isset( $args['deleted'] ) ) + $query .= $wpdb->prepare( "AND deleted = %d ", $args['deleted'] ); + + 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'] ); + } + + $site_results = $wpdb->get_results( $query, ARRAY_A ); + + return $site_results; +} + +/** + * Retrieves a list of reserved site on a sub-directory Multisite install. + * + * @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' + ); + + /** + * Filter reserved site names on a sub-directory Multisite install. + * + * @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 ); +}