Changeset 52823

Timestamp:

03/06/2022 04:09:06 PM (19 months ago)

Author:

SergeyBiryukov

Message:

Users: Bring some consistency to user role hooks.

This standardizes the actions that one needs to hook to for tracking user role changes:

• add_user_role is only fired when the user has actually gained a new role.
• remove_user_role is only fired when the role was actually removed.

Both actions are now fired in WP_User::set_role() as appropriate.

Props dd32, SergeyBiryukov.
Fixes #54164.

Location:

trunk

Files:

• src/wp-includes/class-wp-user.php (modified) (3 diffs)
• tests/phpunit/tests/user/capabilities.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-user.php

@@ -543 +543 @@
         }
 
+        if ( in_array( $role, $this->roles, true ) ) {
+            return;
+        }
+
         $this->caps[ $role ] = true;
         update_user_meta( $this->ID, $this->cap_key, $this->caps );
@@ -570 +574 @@
             return;
         }
+
         unset( $this->caps[ $role ] );
         update_user_meta( $this->ID, $this->cap_key, $this->caps );
@@ -607 +612 @@
 
         $old_roles = $this->roles;
+
         if ( ! empty( $role ) ) {
             $this->caps[ $role ] = true;
             $this->roles         = array( $role => true );
         } else {
-            $this->roles = false;
-        }
+            $this->roles = array();
+        }
+
         update_user_meta( $this->ID, $this->cap_key, $this->caps );
         $this->get_role_caps();
         $this->update_user_level_from_caps();
+
+        foreach ( $old_roles as $old_role ) {
+            if ( ! $old_role || $old_role === $role ) {
+                continue;
+            }
+
+            /** This action is documented in wp-includes/class-wp-user.php */
+            do_action( 'remove_user_role', $this->ID, $old_role );
+        }
+
+        if ( $role && ! in_array( $role, $old_roles, true ) ) {
+            /** This action is documented in wp-includes/class-wp-user.php */
+            do_action( 'add_user_role', $this->ID, $role );
+        }
 
         /**

trunk/tests/phpunit/tests/user/capabilities.php

@@ -1624 +1624 @@
         $caps = $user->caps;
         $this->assertNotEmpty( $user->caps );
+
         $user->set_role( 'administrator' );
         $this->assertNotEmpty( $user->caps );
         $this->assertSame( $caps, $user->caps );
+    }
+
+    /**
+     * @ticket 54164
+     */
+    public function test_set_role_fires_remove_user_role_and_add_user_role_hooks() {
+        $user = self::$users['administrator'];
+
+        $remove_user_role = new MockAction();
+        $add_user_role    = new MockAction();
+        add_action( 'remove_user_role', array( $remove_user_role, 'action' ) );
+        add_action( 'add_user_role', array( $add_user_role, 'action' ) );
+
+        $user->set_role( 'editor' );
+        $this->assertSame( 1, $remove_user_role->get_call_count() );
+        $this->assertSame( 1, $add_user_role->get_call_count() );
     }