Ticket #30483: 30483.2.diff

wp-admin/includes/ms.php

@@ -48 +48 @@
  *
  * @since 3.0.0
  *
- * @param int $blog_id Blog ID
- * @param bool $drop True if blog's table should be dropped. Default is false.
+ * @param int  $blog_id Blog ID
+ * @param bool $drop    True if blog's table should be dropped. Default is false.
  * @return void
  */
 function wpmu_delete_blog( $blog_id, $drop = false ) {
@@ -169 +169 @@
                 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 ID of the user.
+ * @return bool True if the user was deleted, otherwise false.
+ */
 function wpmu_delete_user( $id ) {
         global $wpdb;
 
@@ -225 +233 @@
         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 ) {
         if ( $value == get_option( 'admin_email' ) || !is_email( $value ) )
                 return;
@@ -278 +294 @@
 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
+ */
 function send_confirmation_on_profile_email() {
         global $errors, $wpdb;
         $current_user = wp_get_current_user();
@@ -348 +369 @@
 }
 add_action( 'personal_options_update', 'send_confirmation_on_profile_email' );
 
+/**
+ * Adds an admin notice alterting 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 "<div class='update-nag'>" . sprintf( __( "Your email address has not been updated yet. Please check your inbox at %s for a confirmation email." ), $email['newemail'] ) . "</div>";
@@ -360 +386 @@
  * @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' ) )
@@ -422 +448 @@
         return min( $size, $available );
 }
 
-// Edit blog upload space setting on Edit Blog page
+/**
+ * Displays the edit blog upload space setting form on Edit Blog page.
+ *
+ * @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' );
@@ -440 +472 @@
 }
 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) on multisite installs.
+ *
+ * @since 3.0.0
+ *
+ * @param int    $id         The ID of the user.
+ * @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;
 
@@ -476 +522 @@
         return $value;
 }
 
+/**
+ * Cleans the user cache for a specific user.
+ *
+ * @since 3.0.0
+ *
+ * @param $id The user ID.
+ * @return bool|int The ID of the refreshed user or false if user does not exist.
+ */
 function refresh_user_details( $id ) {
         $id = (int) $id;
 
@@ -487 +541 @@
         return $id;
 }
 
+/**
+ * Returns the language for a language code.
+ *
+ * @since 3.0.0
+ *
+ * @param string $code Optional. The two-letter language code.
+ * @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(
@@ -514 +577 @@
         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 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 ) ) {
@@ -526 +600 @@
 }
 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
+ */
 function _access_denied_splash() {
         if ( ! is_user_logged_in() || is_network_admin() )
                 return;
@@ -560 +639 @@
 }
 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 $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;
@@ -568 +655 @@
 add_filter( 'import_allow_create_users', 'check_import_new_users' );
 // See "import_allow_fetch_attachments" and "import_attachment_size_limit" filters too.
 
+/**
+ * Display a dropdown of available languages.
+ *
+ * @since 3.0.0
+ *
+ * @param array  $lang_files An array of the language files.
+ * @param string $current    The current language code.
+ */
 function mu_dropdown_languages( $lang_files = array(), $current = '' ) {
         $flag = false;
         $output = array();
@@ -608 +703 @@
         echo implode( "\n\t", $output );
 }
 
+/**
+ * Displays an admin notice to upgrade all sites after a WordPress Core Upgrade.
+ *
+ * @since 3.0.0
+ */
 function site_admin_notice() {
         global $wp_db_version;
         if ( !is_super_admin() )
@@ -618 +718 @@
 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;
@@ -641 +753 @@
 }
 add_filter( 'wp_insert_post_data', 'avoid_blog_page_permalink_collision', 10, 2 );
 
+/**
+ * Handles the display of choosing a users primary site.
+ *
+ * This displays the user's primary site and allows the user to choose which site is primary.
+ * Used in wp-admin/my-sites.php.
+ *
+ * @since 3.0.0
+ */
 function choose_primary_blog() {
         ?>
         <table class="form-table">
@@ -696 +816 @@
  * 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.
@@ -740 +861 @@
  * 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.
@@ -783 +905 @@
 }
 
 /**
- * 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;
@@ -813 +937 @@
  * Thickbox image paths for Network Admin.
  *
  * @since 3.1.0
+ *
  * @access private
  */
 function _thickbox_path_admin_subfolder() {