Changeset 25497

Timestamp:

09/19/2013 04:05:21 PM (11 years ago)

Author:

SergeyBiryukov

Message:

Some more tweaks for the documentation in wp-admin/includes/ms.php. see #25229.

File:

• trunk/src/wp-admin/includes/ms.php (modified) (13 diffs)

trunk/src/wp-admin/includes/ms.php

@@ -167 +167 @@
      * @since MU
      *
-     * @param int $id User ID of the user about to be deleted from the network.
+     * @param int $id ID of the user about to be deleted from the network.
      */
     do_action( 'wpmu_delete_user', $id );
@@ -208 +208 @@
      * @since 2.8.0
      *
-     * @param int $id User ID of the user that was deleted from the network.
+     * @param int $id ID of the user that was deleted from the network.
      */
     do_action( 'deleted_user', $id );
@@ -452 +452 @@
              * @since 3.0.0
              * 
-             * @param int $id User ID of the user marked as SPAM.
+             * @param int $id ID of the user marked as SPAM.
              */
             do_action( 'make_spam_user', $id );
@@ -461 +461 @@
              * @since 3.0.0
              * 
-             * @param int $id User ID of the user marked as HAM.
+             * @param int $id ID of the user marked as HAM.
              */
             do_action( 'make_ham_user', $id );
@@ -695 +695 @@
 
 /**
- * Grants super admin privileges.
+ * Grants Super Admin privileges.
  *
  * @since 3.0.0
- * @param int $user_id
+ * @param int $user_id ID of the user to be granted Super Admin privileges.
  */
 function grant_super_admin( $user_id ) {
@@ -704 +704 @@
 
     // If global super_admins override is defined, there is nothing to do here.
-    if ( isset($super_admins) )
+    if ( isset( $super_admins ) )
         return false;
     
@@ -712 +712 @@
      * @since 3.0.0
      *
-     * @param int $user_id User ID of the user that is about to be granted Super Admin privileges.
+     * @param int $user_id ID of the user that is about to be granted Super Admin privileges.
      */
     do_action( 'grant_super_admin', $user_id );
@@ -729 +729 @@
          * @since 3.0.0
          *
-         * @param int $user_id User ID of the user that was granted Super Admin privileges.
+         * @param int $user_id ID of the user that was granted Super Admin privileges.
          */
         do_action( 'granted_super_admin', $user_id );
@@ -738 +738 @@
 
 /**
- * Revokes super admin privileges.
+ * Revokes Super Admin privileges.
  *
  * @since 3.0.0
- * @param int $user_id
+ * @param int $user_id ID of the user Super Admin privileges to be revoked from.
  */
 function revoke_super_admin( $user_id ) {
@@ -747 +747 @@
 
     // If global super_admins override is defined, there is nothing to do here.
-    if ( isset($super_admins) )
+    if ( isset( $super_admins ) )
         return false;
+
     /**
      * Fires before the user's Super Admin privileges are revoked.
@@ -754 +755 @@
      * @since 3.0.0
      *
-     * @param int $user_id User ID of the user Super Admin privileges are being revoked from.
+     * @param int $user_id ID of the user Super Admin privileges are being revoked from.
      */
     do_action( 'revoke_super_admin', $user_id );
@@ -772 +773 @@
              * @since 3.0.0
              *
-             * @param int $user_id User ID of the user Super Admin privileges were revoked from.
+             * @param int $user_id ID of the user Super Admin privileges were revoked from.
              */
             do_action( 'revoked_super_admin', $user_id );
@@ -792 +793 @@
     global $wpdb;
 
-    if ($site_id == $wpdb->siteid )
+    if ( $site_id == $wpdb->siteid )
         $result = true;
     else
         $result = false;
+
     /**
      * Filter whether this network can be edited from this page.