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

Timestamp:

10/08/2025 07:59:28 PM (3 months ago)

Author:

spacedmonkey

Message:

Users: Lazy load user capabilities in WP_User object.

Convert the WP_User object properties caps, roles, and allcaps to protected, and introduce lazy loading for capabilities. These properties are now populated only when first accessed.

The existing magic methods (get, set, and unset) have been updated to maintain backward compatibility, ensuring that reading or modifying these formerly public properties continues to work as expected.

Ensure that these properties are initialised when calling remove_all_caps(), remove_cap(), has_cap(), add_role(), and set_role() methods.

Props spacedmonkey, flixos90, peterwilsoncc, mukesh27, westonruter, swissspidy, prettyboymp.
Fixes #58001.

File:

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

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

@@ -38 +38 @@
  * @property string $syntax_highlighting
  * @property string $use_ssl
+ * @property array<string, bool> $caps
+ * @property string[] $roles
+ * @property array<string, bool> $allcaps
  */
 #[AllowDynamicProperties]
@@ -61 +64 @@
      *
      * @since 2.0.0
-     * @var bool[] Array of key/value pairs where keys represent a capability name
-     *             and boolean values represent whether the user has that capability.
-     */
-    public $caps = array();
+     * @var array<string, bool>|null Array of key/value pairs where keys represent a capability name
+     *                               and boolean values represent whether the user has that capability.
+     */
+    protected $caps = null;
 
     /**
@@ -80 +83 @@
      * @var string[]
      */
-    public $roles = array();
+    protected $roles = array();
 
     /**
@@ -86 +89 @@
      *
      * @since 2.0.0
-     * @var bool[] Array of key/value pairs where keys represent a capability name
-     *             and boolean values represent whether the user has that capability.
-     */
-    public $allcaps = array();
+     * @var array<string, bool> Array of key/value pairs where keys represent a capability name
+     *                          and boolean values represent whether the user has that capability.
+     */
+    protected $allcaps = array();
 
     /**
@@ -289 +292 @@
         }
 
+        if ( in_array( $key, array( 'caps', 'allcaps', 'roles' ), true ) ) {
+            return true;
+        }
+
         if ( isset( $this->data->$key ) ) {
             return true;
@@ -320 +327 @@
             );
             return $this->ID;
+        }
+
+        if ( in_array( $key, array( 'caps', 'allcaps', 'roles' ), true ) ) {
+            $this->load_capability_data();
+            return $this->$key;
         }
 
@@ -364 +376 @@
         }
 
+        // Ensure capability data is loaded before setting related properties.
+        if ( in_array( $key, array( 'caps', 'allcaps', 'roles' ), true ) ) {
+            $this->load_capability_data();
+            $this->$key = $value;
+            return;
+        }
+
         $this->data->$key = $value;
     }
@@ -387 +406 @@
         }
 
+        if ( in_array( $key, array( 'caps', 'allcaps', 'roles' ), true ) ) {
+            $this->$key = null;
+        }
+
         if ( isset( $this->data->$key ) ) {
             unset( $this->data->$key );
@@ -515 +538 @@
 
         $wp_roles = wp_roles();
+
+        // Edge case: In case someone calls this method before lazy initialization, we need to initialize on demand.
+        if ( ! isset( $this->caps ) ) {
+            $this->caps = $this->get_caps_data();
+        }
 
         // Filter out caps that are not role names and assign to $this->roles.
@@ -549 +577 @@
             return;
         }
+        $this->load_capability_data();
 
         if ( in_array( $role, $this->roles, true ) ) {
@@ -578 +607 @@
      */
     public function remove_role( $role ) {
+        $this->load_capability_data();
         if ( ! in_array( $role, $this->roles, true ) ) {
             return;
@@ -610 +640 @@
      */
     public function set_role( $role ) {
+        $this->load_capability_data();
         if ( 1 === count( $this->roles ) && current( $this->roles ) === $role ) {
             return;
@@ -711 +742 @@
      */
     public function add_cap( $cap, $grant = true ) {
+        $this->load_capability_data();
         $this->caps[ $cap ] = $grant;
         update_user_meta( $this->ID, $this->cap_key, $this->caps );
@@ -725 +757 @@
      */
     public function remove_cap( $cap ) {
+        $this->load_capability_data();
         if ( ! isset( $this->caps[ $cap ] ) ) {
             return;
@@ -743 +776 @@
     public function remove_all_caps() {
         global $wpdb;
-        $this->caps = array();
+        $this->caps = null;
         delete_user_meta( $this->ID, $this->cap_key );
         delete_user_meta( $this->ID, $wpdb->get_blog_prefix() . 'user_level' );
-        $this->get_role_caps();
+        $this->load_capability_data();
     }
 
@@ -777 +810 @@
      */
     public function has_cap( $cap, ...$args ) {
+        $this->load_capability_data();
+
         if ( is_numeric( $cap ) ) {
             _deprecated_argument( __FUNCTION__, '2.0.0', __( 'Usage of user levels is deprecated. Use capabilities instead.' ) );
@@ -878 +913 @@
 
         $this->cap_key = $wpdb->get_blog_prefix( $this->site_id ) . 'capabilities';
-
-        $this->caps = $this->get_caps_data();
-
-        $this->get_role_caps();
+        $this->caps    = null;
     }
 
@@ -912 +944 @@
         return $caps;
     }
+
+    /**
+     * Loads capability data if it has not been loaded yet.
+     *
+     * @since 6.9.0
+     */
+    private function load_capability_data() {
+        if ( isset( $this->caps ) ) {
+            return;
+        }
+        $this->caps = $this->get_caps_data();
+        $this->get_role_caps();
+    }
 }