Changeset 10323 for trunk/wp-admin/includes/user.php

Timestamp:

01/06/2009 10:00:05 PM (16 years ago)

Author:

ryan

Message:

Add get_editable_roles() and role filtering. Props jeremyclarke. fixes #8770

File:

• trunk/wp-admin/includes/user.php (modified) (5 diffs)

trunk/wp-admin/includes/user.php

@@ -10 +10 @@
  * Creates a new user from the "Users" form using $_POST information.
  *
- * {@internal Missing Long Description}}
- *
- * @since unknown
+ * It seems that the first half is for backwards compatibility, but only
+ * has the ability to alter the user's role. Wordpress core seems to 
+ * use this function only in the second way, running edit_user() with
+ * no id so as to create a new user.
+ *
+ * @since 2.0
  *
  * @param int $user_id Optional. User ID.
@@ -23 +26 @@
 
         if ( isset( $_POST['role'] ) ) {
+            // Don't let anyone with 'edit_users' (admins) edit their own role to something without it.
             if( $user_id != $current_user->id || $wp_roles->role_objects[$_POST['role']]->has_cap( 'edit_users' ) ) {
+                // If the new role isn't editable by the logged-in user die with error
+                $editable_roles = get_editable_roles();
+                if (!$editable_roles[$_POST['role']])
+                    wp_die(__('You can’t give users that role.'));
+                
                 $user = new WP_User( $user_id );
                 $user->set_role( $_POST['role'] );
@@ -35 +44 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * {@internal Missing Long Description}}
- *
- * @since unknown
+ * Edit user settings based on contents of $_POST
+ *
+ * Used on user-edit.php and profile.php to manage and process user options, passwords etc.
+ *
+ * @since 2.0
  *
  * @param int $user_id Optional. User ID.
- * @return unknown
+ * @return int user id of the updated user
  */
 function edit_user( $user_id = 0 ) {
@@ -66 +75 @@
 
     if ( isset( $_POST['role'] ) && current_user_can( 'edit_users' ) ) {
+
+        // Don't let anyone with 'edit_users' (admins) edit their own role to something without it.
         if( $user_id != $current_user->id || $wp_roles->role_objects[$_POST['role']]->has_cap( 'edit_users' ))
-            $user->role = $_POST['role'];
+            $user->role = $_POST['role']; 
+
+        // If the new role isn't editable by the logged-in user die with error
+        $editable_roles = get_editable_roles();
+        if (!$editable_roles[$_POST['role']])
+            wp_die(__('You can’t give users that role.'));
     }
 
@@ -243 +259 @@
 
 /**
+ * Fetch a filtered list of user roles that the current user is 
+ * allowed to edit. 
+ *
+ * Simple function who's main purpose is to allow filtering of the 
+ * list of roles in the $wp_roles object so that plugins can remove
+ * innappropriate ones depending on the situation or user making edits.
+ * Specifically because without filtering anyone with the edit_users
+ * capability can edit others to be administrators, even if they are
+ * only editors or authors. This filter allows admins to delegate
+ * user management. 
+ *
+ * @since 2.8
+ *
+ * @return unknown
+ */
+function get_editable_roles() {
+    global $wp_roles;
+
+    $all_roles = $wp_roles->roles;
+    $editable_roles = apply_filters('editable_roles', $all_roles);  
+    
+    return $editable_roles;
+}
+
+/**
  * {@internal Missing Short Description}}
  *