X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/72836ec95a52eacbda4dc5aa296b7dd6de08bd3b..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/wp-includes/ms-functions.php diff --git a/wp-includes/ms-functions.php b/wp-includes/ms-functions.php index fd92b2c5..5537fb36 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. */ @@ -51,16 +49,13 @@ function get_admin_users_for_domain( $sitedomain = '', $path = '' ) { /** * 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() * * @param int $user_id The unique ID of the user * @return object The blog object @@ -194,7 +189,16 @@ 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' ); restore_current_blog(); return true; @@ -220,7 +224,15 @@ 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,8 +270,18 @@ 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) ); + $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 ) ); + + 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 ( ! 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' ); + } } restore_current_blog(); @@ -271,7 +293,6 @@ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') { * 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. @@ -401,6 +422,14 @@ 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 ); } @@ -420,9 +449,6 @@ function is_email_address_unsafe( $user_email ) { * 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. * @param string $user_email The email provided by the user. @@ -510,7 +536,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 ); } /** @@ -528,16 +571,15 @@ 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. * @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 ); @@ -550,9 +592,23 @@ 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, + /** + * Filter reserved site names on a sub-directory Multisite install. + * + * @since 3.0.0 + * + * @param array $subdirectory_reserved_names Array of reserved names. + */ + apply_filters( 'subdirectory_reserved_names', array( 'page', 'comments', 'blog', 'files', 'feed' ) ) + ); + } if ( empty( $blogname ) ) $errors->add('blogname', __( 'Please enter a site name.' ) ); @@ -577,6 +633,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 ); @@ -612,14 +678,30 @@ 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 $user User email address. + * @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. @@ -655,7 +737,6 @@ 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. * @param string $user_email The user's email address. @@ -709,13 +790,25 @@ function wpmu_signup_user( $user, $user_email, $meta = array() ) { * @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) ) + /** + * 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 @@ -727,6 +820,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( + /** + * 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 @@ -737,6 +846,20 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema ); // 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 @@ -744,7 +867,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; } @@ -770,7 +893,17 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema * @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) ) + /** + * 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. @@ -780,6 +913,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( + /** + * 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 @@ -788,6 +934,17 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array( ); // 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 @@ -795,7 +952,7 @@ 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; } @@ -808,12 +965,6 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array( * 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() * * @param string $key The activation key provided to the user. * @return array An array containing information about the activated user and/or blog @@ -855,6 +1006,15 @@ function wpmu_activate_signup($key) { 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 ); } @@ -874,7 +1034,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); } @@ -888,12 +1059,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 + * @return int|bool 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 +1076,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; @@ -924,10 +1101,6 @@ 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. @@ -982,6 +1155,18 @@ 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 ); return $blog_id; @@ -1018,6 +1203,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 ); @@ -1031,7 +1224,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 @@ -1053,6 +1245,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; @@ -1073,7 +1274,19 @@ Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['RE */ 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 ); } @@ -1116,24 +1329,22 @@ 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(). * @param string $blog_title The title of the new site. */ -function install_blog($blog_id, $blog_title = '') { - global $wpdb, $wp_roles, $current_site; +function install_blog( $blog_id, $blog_title = '' ) { + global $wpdb, $wp_roles; // Cast for security $blog_id = (int) $blog_id; 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 ); @@ -1141,7 +1352,9 @@ function install_blog($blog_id, $blog_title = '') { make_db_current_silent( 'blog' ); populate_options(); populate_roles(); - $wp_roles->_init(); + + // populate_roles() clears previous role definitions so we start over. + $wp_roles = new WP_Roles(); $url = untrailingslashit( $url ); @@ -1151,7 +1364,7 @@ function install_blog($blog_id, $blog_title = '') { 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', '' ); @@ -1170,7 +1383,6 @@ function install_blog($blog_id, $blog_title = '') { * @since MU * @deprecated MU * @deprecated Use wp_install_defaults() - * @uses wp_install_defaults() * * @param int $blog_id Ignored in this function. * @param int $user_id @@ -1180,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. * @@ -1205,9 +1417,22 @@ function install_blog_defaults($blog_id, $user_id) { * @return bool */ function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) { - global $current_site; + $current_site = get_current_site(); - if ( !apply_filters('wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta) ) + /** + * 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' ); @@ -1218,6 +1443,7 @@ 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 @@ -1235,7 +1461,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 == '' ) @@ -1248,13 +1488,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. * @@ -1269,16 +1516,39 @@ We hope you enjoy your new site. Thanks! * @return bool */ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) { - global $current_site; + $current_site = get_current_site(); - if ( !apply_filters('wpmu_welcome_user_notification', $user_id, $password, $meta) ) + /** + * 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); + /** + * Filter the content of the welcome email after user activation. + * + * Content should be formatted for transmission via wp_mail(). + * + * @since MU + * + * @param type $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 ); @@ -1296,8 +1566,15 @@ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) 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; } @@ -1325,7 +1602,6 @@ function get_current_site() { * the most recent post_date_gmt. * * @since MU - * @uses get_blogs_of_user() * * @param int $user_id * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts @@ -1372,7 +1648,6 @@ 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 @@ -1443,7 +1718,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 ) @@ -1459,7 +1735,7 @@ 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 */ @@ -1560,8 +1836,7 @@ function global_terms( $term_id, $deprecated = '' ) { * @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 ); } /** @@ -1586,7 +1861,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(); @@ -1598,7 +1872,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 @@ -1619,6 +1892,15 @@ function signup_nonce_check( $result ) { * @since MU */ function maybe_redirect_404() { + /** + * 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(); @@ -1635,7 +1917,6 @@ 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/' ) ) @@ -1661,7 +1942,6 @@ function maybe_add_existing_user_to_blog() { * Add a user to a blog based on details from maybe_add_existing_user_to_blog(). * * @since MU - * @uses add_user_to_blog() * * @param array $details */ @@ -1670,7 +1950,15 @@ function add_existing_user_to_blog( $details = false ) { 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; } @@ -1689,11 +1977,10 @@ function add_existing_user_to_blog( $details = false ) { * @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 ); } @@ -1705,15 +1992,13 @@ function add_new_user_to_blog( $user_id, $password, $meta ) { * @since MU */ 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|WP_User $user Optional. Defaults to current user. WP_User object, * or user login name as a string. @@ -1736,11 +2021,9 @@ function is_user_spammy( $user = 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 */ function update_blog_public( $old_value, $value ) { update_blog_status( get_current_blog_id(), 'public', (int) $value ); @@ -1751,7 +2034,6 @@ add_action('update_option_blog_public', 'update_blog_public', 10, 2); * Check whether a usermeta key has to do with the current blog. * * @since MU - * @uses wp_get_current_user() * * @param string $key * @param int $user_id Optional. Defaults to current user. @@ -1762,11 +2044,9 @@ 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 ) ) @@ -1890,18 +2170,18 @@ function wp_update_network_counts() { * on a network when a site is created or its status is updated. * * @since 3.7.0 - * - * @uses wp_update_network_site_counts() */ function wp_maybe_update_network_site_counts() { $is_small_network = ! wp_is_large_network( 'sites' ); /** - * Filter the decision to update network user and site counts in real time. + * Filter whether to update network site or user counts when a new site is created. * * @since 3.7.0 * - * @param bool $small_network Based on wp_is_large_network( $context ). + * @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' ) ) @@ -1917,20 +2197,11 @@ function wp_maybe_update_network_site_counts() { * on a network when a user is created or its status is updated. * * @since 3.7.0 - * - * @uses wp_update_network_user_counts() */ function wp_maybe_update_network_user_counts() { $is_small_network = ! wp_is_large_network( 'users' ); - /** - * Filter the decision to update network user and site counts in real time. - * - * @since 3.7.0 - * - * @param bool $small_network Based on wp_is_large_network( $context ). - * @param string $context Context. Either 'users' or 'sites'. - */ + /** This filter is documented in wp-includes/ms-functions.php */ if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) ) return; @@ -1969,7 +2240,13 @@ function wp_update_network_user_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(); @@ -1995,6 +2272,13 @@ function get_space_allowed() { if ( empty( $space_allowed ) || ! 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 ); } @@ -2057,10 +2341,20 @@ 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 ); }