Changeset 39082

Timestamp:

11/02/2016 12:30:29 AM (9 years ago)

Author:

pento

Message:

Roles/Capabilities: Add a new wp_roles_init filter.

Historically, it's been difficult to extend user roles, but reasonable to work around by waiting until after init has fired, to add custom roles and capabilities. With the addition of Locale Switching, Core now potentially loads roles before init has fired, leaving a window where custom roles and capabilities are not handled.

The new filter allows plugins to add their own custom roles whenever they're initialised (on page load, or when switching sites, for example), so that they can always be obeyed.

WP_Roles has also been tidied up a little bit, to remove duplicate code.

Props johnjamesjacoby, pento.
Fixes #23016.

Location:

trunk

Files:

• src/wp-includes/class-wp-roles.php (modified) (2 diffs)
• src/wp-includes/ms-blogs.php (modified) (4 diffs)
• tests/phpunit/tests/user/capabilities.php (modified) (2 diffs)
• tests/phpunit/tests/user/multisite.php (modified) (1 diff)

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

@@ -128 +128 @@
             $this->role_names[$role] = $this->roles[$role]['name'];
         }
+
+        /**
+         * After the roles have been initialized, allow plugins to add their own roles.
+         *
+         * @since 4.7.0
+         *
+         * @param WP_Roles A reference to the WP_Roles object.
+         */
+        do_action( 'wp_roles_init', $this );
     }
 
@@ -137 +146 @@
      *
      * @since 3.5.0
+     * @deprecated 4.7.0 Use new WP_Roles()
      * @access public
      */
     public function reinit() {
-        global $wpdb;
-
-        // There is no need to reinit if using the wp_user_roles global.
-        if ( ! $this->use_db ) {
-            return;
-        }
-
-        // Duplicated from _init() to avoid an extra function call.
-        $this->role_key = $wpdb->get_blog_prefix() . 'user_roles';
-        $this->roles = get_option( $this->role_key );
-        if ( empty( $this->roles ) )
-            return;
-
-        $this->role_objects = array();
-        $this->role_names =  array();
-        foreach ( array_keys( $this->roles ) as $role ) {
-            $this->role_objects[$role] = new WP_Role( $role, $this->roles[$role]['capabilities'] );
-            $this->role_names[$role] = $this->roles[$role]['name'];
-        }
+        __deprecated_function( __METHOD__, '4.7.0', 'new WP_Roles()' );
+        $this->_init();
     }
 

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

@@ -767 +767 @@
  */
 function switch_to_blog( $new_blog, $deprecated = null ) {
-    global $wpdb;
+    global $wpdb, $wp_roles;
 
     $blog_id = get_current_blog_id();
@@ -823 +823 @@
 
     if ( did_action( 'init' ) ) {
-        wp_roles()->reinit();
+        $wp_roles = new WP_Roles();
         $current_user = wp_get_current_user();
         $current_user->for_blog( $new_blog );
@@ -851 +851 @@
  */
 function restore_current_blog() {
-    global $wpdb;
+    global $wpdb, $wp_roles;
 
     if ( empty( $GLOBALS['_wp_switched_stack'] ) ) {
@@ -897 +897 @@
 
     if ( did_action( 'init' ) ) {
-        wp_roles()->reinit();
+        $wp_roles = new WP_Roles();
         $current_user = wp_get_current_user();
         $current_user->for_blog( $blog );

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

@@ -42 +42 @@
         unset($GLOBALS['wp_user_roles']);
         global $wp_roles;
-        if ( is_object( $wp_roles ) )
-            $wp_roles->_init();
+        $wp_roles = new WP_Roles();
     }
 
@@ -1627 +1626 @@
     }
 
+    protected $_role_test_wp_roles_role;
+    /**
+     * @ticket 23016
+     */
+    public function test_wp_roles_init_action() {
+        $this->_role_test_wp_roles_init = array(
+            'role' => 'test_wp_roles_init',
+            'info' => array(
+                'name' => 'Test WP Roles Init',
+                'capabilities' => array( 'testing_magic' => true ),
+            ),
+        );
+        add_action( 'wp_roles_init', array( $this, '_hook_wp_roles_init' ), 10, 1 );
+
+        $wp_roles = new WP_Roles();
+
+        remove_action( 'wp_roles_init', array( $this, '_hook_wp_roles_init' ) );
+
+        $expected = new WP_Role( $this->_role_test_wp_roles_init['role'], $this->_role_test_wp_roles_init['info']['capabilities'] );
+
+        $role = $wp_roles->get_role( $this->_role_test_wp_roles_init['role'] );
+
+        $this->assertEquals( $expected, $role );
+        $this->assertContains( $this->_role_test_wp_roles_init['info']['name'], $wp_roles->role_names );
+    }
+
+    public function _hook_wp_roles_init( $wp_roles ) {
+        $wp_roles->add_role( $this->_role_test_wp_roles_init['role'], $this->_role_test_wp_roles_init['info']['name'], $this->_role_test_wp_roles_init['info']['capabilities'] );
+    }
 }

trunk/tests/phpunit/tests/user/multisite.php

@@ -397 +397 @@
         $this->assertWPError( $result );
     }
+
+    /**
+     * @ticket 23016
+     */
+    public function test_wp_roles_global_is_reset() {
+        global $wp_roles;
+        $role = 'test_global_is_reset';
+        $role_name = 'Test Global Is Reset';
+        $blog_id = self::factory()->blog->create();
+
+        $wp_roles->add_role( $role, $role_name, array() );
+
+        $this->assertNotEmpty( $wp_roles->get_role( $role ) );
+
+        switch_to_blog( $blog_id );
+
+        $this->assertEmpty( $wp_roles->get_role( $role ) );
+
+        $wp_roles->add_role( $role, $role_name, array() );
+
+        $this->assertNotEmpty( $wp_roles->get_role( $role ) );
+
+        restore_current_blog();
+
+        $this->assertNotEmpty( $wp_roles->get_role( $role ) );
+
+        $wp_roles->remove_role( $role );
+    }
 }