Changeset 52823 for trunk/src/wp-includes/class-wp-user.php

Timestamp:

03/06/2022 04:09:06 PM (5 years 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.

File:

• trunk/src/wp-includes/class-wp-user.php (modified) (3 diffs)

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 );
+                }
 
                 /**