X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..1132430022383fdf47fa6cb9377300fd885297aa:/wp-admin/includes/ms.php diff --git a/wp-admin/includes/ms.php b/wp-admin/includes/ms.php index 7c3f4bba..a9c62bb5 100644 --- a/wp-admin/includes/ms.php +++ b/wp-admin/includes/ms.php @@ -35,24 +35,24 @@ function check_upload_size( $file ) { if ( upload_is_user_over_quota( false ) ) { $file['error'] = __( 'You have used your space quota. Please delete files before uploading.' ); } - if ( $file['error'] != '0' && !isset($_POST['html-upload']) ) + if ( $file['error'] != '0' && ! isset( $_POST['html-upload'] ) && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) ) { wp_die( $file['error'] . ' ' . __( 'Back' ) . '' ); + } return $file; } add_filter( 'wp_handle_upload_prefilter', 'check_upload_size' ); /** - * Delete a blog + * Delete a blog. * * @since 3.0.0 * - * @param int $blog_id Blog ID - * @param bool $drop True if blog's table should be dropped. Default is false. - * @return void + * @param int $blog_id Blog ID. + * @param bool $drop True if blog's table should be dropped. Default is false. */ function wpmu_delete_blog( $blog_id, $drop = false ) { - global $wpdb, $current_site; + global $wpdb; $switch = false; if ( get_current_blog_id() != $blog_id ) { @@ -82,11 +82,28 @@ function wpmu_delete_blog( $blog_id, $drop = false ) { update_blog_status( $blog_id, 'deleted', 1 ); + $current_site = get_current_site(); + + // If a full blog object is not available, do not destroy anything. + if ( $drop && ! $blog ) { + $drop = false; + } + // Don't destroy the initial, main, or root blog. - if ( $drop && ( 1 == $blog_id || is_main_site( $blog_id ) || ( $blog->path == $current_site->path && $blog->domain == $current_site->domain ) ) ) + if ( $drop && ( 1 == $blog_id || is_main_site( $blog_id ) || ( $blog->path == $current_site->path && $blog->domain == $current_site->domain ) ) ) { + $drop = false; + } + + $upload_path = trim( get_option( 'upload_path' ) ); + + // If ms_files_rewriting is enabled and upload_path is empty, wp_upload_dir is not reliable. + if ( $drop && get_site_option( 'ms_files_rewriting' ) && empty( $upload_path ) ) { $drop = false; + } if ( $drop ) { + $uploads = wp_upload_dir(); + $tables = $wpdb->tables( 'blog' ); /** * Filter the tables to drop when the blog is deleted. @@ -104,7 +121,6 @@ function wpmu_delete_blog( $blog_id, $drop = false ) { $wpdb->delete( $wpdb->blogs, array( 'blog_id' => $blog_id ) ); - $uploads = wp_upload_dir(); /** * Filter the upload base directory to delete when the blog is deleted. * @@ -152,7 +168,16 @@ function wpmu_delete_blog( $blog_id, $drop = false ) { restore_current_blog(); } -// @todo Merge with wp_delete_user() ? +/** + * Delete a user from the network and remove from all sites. + * + * @since 3.0.0 + * + * @todo Merge with wp_delete_user() ? + * + * @param int $id The user ID. + * @return bool True if the user was deleted, otherwise false. + */ function wpmu_delete_user( $id ) { global $wpdb; @@ -202,20 +227,21 @@ function wpmu_delete_user( $id ) { clean_user_cache( $user ); - /** - * Fires after the user is deleted from the network. - * - * @since 2.8.0 - * - * @param int $id ID of the user that was deleted from the network. - */ + /** This action is documented in wp-admin/includes/user.php */ do_action( 'deleted_user', $id ); return true; } +/** + * Sends an email when a site administrator email address is changed. + * + * @since 3.0.0 + * + * @param string $old_value The old email address. Not currently used. + * @param string $value The new email address. + */ function update_option_new_admin_email( $old_value, $value ) { - $email = get_option( 'admin_email' ); if ( $value == get_option( 'admin_email' ) || !is_email( $value ) ) return; @@ -263,11 +289,19 @@ All at ###SITENAME### $content = str_replace( '###SITENAME###', get_site_option( 'site_name' ), $content ); $content = str_replace( '###SITEURL###', network_home_url(), $content ); - wp_mail( $value, sprintf( __( '[%s] New Admin Email Address' ), get_option( 'blogname' ) ), $content ); + wp_mail( $value, sprintf( __( '[%s] New Admin Email Address' ), wp_specialchars_decode( get_option( 'blogname' ) ) ), $content ); } add_action( 'update_option_new_admin_email', 'update_option_new_admin_email', 10, 2 ); add_action( 'add_option_new_admin_email', 'update_option_new_admin_email', 10, 2 ); +/** + * Sends an email when an email address change is requested. + * + * @since 3.0.0 + * + * @global object $errors WP_Error object. + * @global object $wpdb WordPress database object. + */ function send_confirmation_on_profile_email() { global $errors, $wpdb; $current_user = wp_get_current_user(); @@ -332,12 +366,18 @@ All at ###SITENAME### $content = str_replace( '###SITENAME###', get_site_option( 'site_name' ), $content ); $content = str_replace( '###SITEURL###', network_home_url(), $content ); - wp_mail( $_POST['email'], sprintf( __( '[%s] New Email Address' ), get_option( 'blogname' ) ), $content ); + wp_mail( $_POST['email'], sprintf( __( '[%s] New Email Address' ), wp_specialchars_decode( get_option( 'blogname' ) ) ), $content ); $_POST['email'] = $current_user->user_email; } } add_action( 'personal_options_update', 'send_confirmation_on_profile_email' ); +/** + * Adds an admin notice alerting the user to check for confirmation email + * after email address change. + * + * @since 3.0.0 + */ function new_user_email_admin_notice() { if ( strpos( $_SERVER['PHP_SELF'], 'profile.php' ) && isset( $_GET['updated'] ) && $email = get_option( get_current_user_id() . '_new_email' ) ) echo "
" . sprintf( __( "Your email address has not been updated yet. Please check your inbox at %s for a confirmation email." ), $email['newemail'] ) . "
"; @@ -350,7 +390,7 @@ add_action( 'admin_notices', 'new_user_email_admin_notice' ); * @since MU * * @param bool $echo Optional. If $echo is set and the quota is exceeded, a warning message is echoed. Default is true. - * @return int + * @return bool True if user is over upload space quota, otherwise false. */ function upload_is_user_over_quota( $echo = true ) { if ( get_site_option( 'upload_space_check_disabled' ) ) @@ -400,9 +440,6 @@ function display_space_usage() { * Get the remaining upload space for this blog. * * @since MU - * @uses upload_is_user_over_quota() - * @uses get_space_allowed() - * @uses get_upload_space_available() * * @param int $size Current max size in bytes * @return int Max size in bytes @@ -415,7 +452,13 @@ function fix_import_form_size( $size ) { return min( $size, $available ); } -// Edit blog upload space setting on Edit Blog page +/** + * Displays the edit blog upload space setting form on the Edit Blog screen. + * + * @since 3.0.0 + * + * @param int $id The ID of the blog to display the setting for. + */ function upload_space_setting( $id ) { switch_to_blog( $id ); $quota = get_option( 'blog_upload_space' ); @@ -433,6 +476,20 @@ function upload_space_setting( $id ) { } add_action( 'wpmueditblogaction', 'upload_space_setting' ); +/** + * Update the status of a user in the database. + * + * Used in core to mark a user as spam or "ham" (not spam) in Multisite. + * + * @since 3.0.0 + * + * @param int $id The user ID. + * @param string $pref The column in the wp_users table to update the user's status + * in (presumably user_status, spam, or deleted). + * @param int $value The new status for the user. + * @param null $deprecated Deprecated as of 3.0.2 and should not be used. + * @return int The initially passed $value. + */ function update_user_status( $id, $pref, $value, $deprecated = null ) { global $wpdb; @@ -469,6 +526,14 @@ function update_user_status( $id, $pref, $value, $deprecated = null ) { return $value; } +/** + * Cleans the user cache for a specific user. + * + * @since 3.0.0 + * + * @param int $id The user ID. + * @return bool|int The ID of the refreshed user or false if the user does not exist. + */ function refresh_user_details( $id ) { $id = (int) $id; @@ -480,6 +545,15 @@ function refresh_user_details( $id ) { return $id; } +/** + * Returns the language for a language code. + * + * @since 3.0.0 + * + * @param string $code Optional. The two-letter language code. Default empty. + * @return string The language corresponding to $code if it exists. If it does not exist, + * then the first two letters of $code is returned. + */ function format_code_lang( $code = '' ) { $code = strtolower( substr( $code, 0, 2 ) ); $lang_codes = array( @@ -507,6 +581,18 @@ function format_code_lang( $code = '' ) { return strtr( $code, $lang_codes ); } +/** + * Synchronize category and post tag slugs when global terms are enabled. + * + * @since 3.0.0 + * + * @param $term The term. + * @param $taxonomy The taxonomy for $term. Should be 'category' or 'post_tag', as these are + * the only taxonomies which are processed by this function; anything else + * will be returned untouched. + * @return object|array Returns `$term`, after filtering the 'slug' field with {@see sanitize_title()} + * if $taxonomy is 'category' or 'post_tag'. + */ function sync_category_tag_slugs( $term, $taxonomy ) { if ( global_terms_enabled() && ( $taxonomy == 'category' || $taxonomy == 'post_tag' ) ) { if ( is_object( $term ) ) { @@ -519,6 +605,13 @@ function sync_category_tag_slugs( $term, $taxonomy ) { } add_filter( 'get_term', 'sync_category_tag_slugs', 10, 2 ); +/** + * Displays an access denied message when a user tries to view a site's dashboard they + * do not have access to. + * + * @since 3.2.0 + * @access private + */ function _access_denied_splash() { if ( ! is_user_logged_in() || is_network_admin() ) return; @@ -540,21 +633,27 @@ function _access_denied_splash() { $output .= ''; foreach ( $blogs as $blog ) { - $output .= ""; - $output .= ""; - $output .= ""; - $output .= ""; + $output .= ''; + $output .= ""; + $output .= ''; + $output .= ''; } + $output .= '
"; - $output .= "{$blog->blogname}"; - $output .= ""; - $output .= "" . __( 'Visit Dashboard' ) . " | " . __( 'View Site' ) . "" ; - $output .= "
{$blog->blogname}' . __( 'Visit Dashboard' ) . ' | ' . + '' . __( 'View Site' ) . '
'; wp_die( $output ); } add_action( 'admin_page_access_denied', '_access_denied_splash', 99 ); +/** + * Checks if the current user has permissions to import new users. + * + * @since 3.0.0 + * + * @param string $permission A permission to be checked. Currently not used. + * @return bool True if the user has proper permissions, false if they do not. + */ function check_import_new_users( $permission ) { if ( !is_super_admin() ) return false; @@ -563,6 +662,14 @@ function check_import_new_users( $permission ) { add_filter( 'import_allow_create_users', 'check_import_new_users' ); // See "import_allow_fetch_attachments" and "import_attachment_size_limit" filters too. +/** + * Generates and displays a drop-down of available languages. + * + * @since 3.0.0 + * + * @param array $lang_files Optional. An array of the language files. Default empty array. + * @param string $current Optional. The current language code. Default empty. + */ function mu_dropdown_languages( $lang_files = array(), $current = '' ) { $flag = false; $output = array(); @@ -590,6 +697,7 @@ function mu_dropdown_languages( $lang_files = array(), $current = '' ) { // Order by name uksort( $output, 'strnatcasecmp' ); + /** * Filter the languages available in the dropdown. * @@ -600,9 +708,17 @@ function mu_dropdown_languages( $lang_files = array(), $current = '' ) { * @param string $current The current language code. */ $output = apply_filters( 'mu_dropdown_languages', $output, $lang_files, $current ); + echo implode( "\n\t", $output ); } +/** + * Displays an admin notice to upgrade all sites after a core upgrade. + * + * @since 3.0.0 + * + * @global int $wp_db_version The version number of the database. + */ function site_admin_notice() { global $wp_db_version; if ( !is_super_admin() ) @@ -613,6 +729,18 @@ function site_admin_notice() { add_action( 'admin_notices', 'site_admin_notice' ); add_action( 'network_admin_notices', 'site_admin_notice' ); +/** + * Avoids a collision between a site slug and a permalink slug. + * + * In a subdirectory install this will make sure that a site and a post do not use the + * same subdirectory by checking for a site with the same name as a new post. + * + * @since 3.0.0 + * + * @param array $data An array of post data. + * @param array $postarr An array of posts. Not currently used. + * @return array The new array of post data after checking for collisions. + */ function avoid_blog_page_permalink_collision( $data, $postarr ) { if ( is_subdomain_install() ) return $data; @@ -636,6 +764,14 @@ function avoid_blog_page_permalink_collision( $data, $postarr ) { } add_filter( 'wp_insert_post_data', 'avoid_blog_page_permalink_collision', 10, 2 ); +/** + * Handles the display of choosing a user's primary site. + * + * This displays the user's primary site and allows the user to choose + * which site is primary. + * + * @since 3.0.0 + */ function choose_primary_blog() { ?> @@ -676,10 +812,10 @@ function choose_primary_blog() { @@ -691,14 +827,16 @@ function choose_primary_blog() { * Grants Super Admin privileges. * * @since 3.0.0 + * * @param int $user_id ID of the user to be granted Super Admin privileges. + * @return bool True on success, false on failure. This can fail when the user is + * already a super admin or when the `$super_admins` global is defined. */ function grant_super_admin( $user_id ) { - global $super_admins; - // If global super_admins override is defined, there is nothing to do here. - if ( isset( $super_admins ) ) + if ( isset( $GLOBALS['super_admins'] ) ) { return false; + } /** * Fires before the user is granted Super Admin privileges. @@ -734,14 +872,16 @@ function grant_super_admin( $user_id ) { * Revokes Super Admin privileges. * * @since 3.0.0 + * * @param int $user_id ID of the user Super Admin privileges to be revoked from. + * @return bool True on success, false on failure. This can fail when the user's email + * is the network admin email or when the `$super_admins` global is defined. */ function revoke_super_admin( $user_id ) { - global $super_admins; - // If global super_admins override is defined, there is nothing to do here. - if ( isset( $super_admins ) ) + if ( isset( $GLOBALS['super_admins'] ) ) { return false; + } /** * Fires before the user's Super Admin privileges are revoked. @@ -756,7 +896,7 @@ function revoke_super_admin( $user_id ) { $super_admins = get_site_option( 'site_admins', array( 'admin' ) ); $user = get_userdata( $user_id ); - if ( $user && $user->user_email != get_site_option( 'admin_email' ) ) { + if ( $user && 0 !== strcasecmp( $user->user_email, get_site_option( 'admin_email' ) ) ) { if ( false !== ( $key = array_search( $user->user_login, $super_admins ) ) ) { unset( $super_admins[$key] ); update_site_option( 'site_admins', $super_admins ); @@ -776,12 +916,15 @@ function revoke_super_admin( $user_id ) { } /** - * Whether or not we can edit this network from this page + * Whether or not we can edit this network from this page. * - * By default editing of network is restricted to the Network Admin for that site_id this allows for this to be overridden + * By default editing of network is restricted to the Network Admin for that `$site_id` + * this allows for this to be overridden. * * @since 3.1.0 - * @param integer $site_id The network/site ID to check. + * + * @param int $site_id The network/site ID to check. + * @return bool True if network can be edited, otherwise false. */ function can_edit_network( $site_id ) { global $wpdb; @@ -806,13 +949,14 @@ function can_edit_network( $site_id ) { * Thickbox image paths for Network Admin. * * @since 3.1.0 + * * @access private */ function _thickbox_path_admin_subfolder() { ?>
- +