Changeset 59198 for trunk/tests/phpunit/tests/user/capabilities.php

Timestamp:

10/08/2024 10:30:57 PM (16 months ago)

Author:

johnbillion

Message:

Role/Capability: Introduce the current_user_can_for_site() and user_can_for_site() functions.

The current_user_can_for_site() function is a replacement for current_user_can_for_blog() which is now deprecated. user_can_for_site() is a renaming of the user_can_for_blog() function which was introduced in [59123]. The intention of this change is to prevent the introduction of a new function which uses the old "blog" naming structure.

Props swissspidy, spacedmonkey, flixos90, johnjamesjacoby

Fixes #45197

File:

• trunk/tests/phpunit/tests/user/capabilities.php (modified) (11 diffs)

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

@@ -1655 +1655 @@
 
     /**
-     * @group can_for_blog
-     */
-    public function test_current_user_can_for_blog() {
+     * @group can_for_site
+     */
+    public function test_current_user_can_for_site() {
         global $wpdb;
 
@@ -1664 +1664 @@
         wp_set_current_user( $user->ID );
 
-        $this->assertTrue( current_user_can_for_blog( get_current_blog_id(), 'edit_posts' ) );
-        $this->assertFalse( current_user_can_for_blog( get_current_blog_id(), 'foo_the_bar' ) );
+        $this->assertTrue( current_user_can_for_site( get_current_blog_id(), 'edit_posts' ) );
+        $this->assertFalse( current_user_can_for_site( get_current_blog_id(), 'foo_the_bar' ) );
 
         if ( ! is_multisite() ) {
-            $this->assertTrue( current_user_can_for_blog( 12345, 'edit_posts' ) );
-            $this->assertFalse( current_user_can_for_blog( 12345, 'foo_the_bar' ) );
+            $this->assertTrue( current_user_can_for_site( 12345, 'edit_posts' ) );
+            $this->assertFalse( current_user_can_for_site( 12345, 'foo_the_bar' ) );
             return;
         }
 
         $suppress = $wpdb->suppress_errors();
-        $this->assertFalse( current_user_can_for_blog( 12345, 'edit_posts' ) );
+        $this->assertFalse( current_user_can_for_site( 12345, 'edit_posts' ) );
         $wpdb->suppress_errors( $suppress );
 
@@ -1680 +1680 @@
 
         $this->assertNotWPError( $blog_id );
-        $this->assertTrue( current_user_can_for_blog( $blog_id, 'edit_posts' ) );
-        $this->assertFalse( current_user_can_for_blog( $blog_id, 'foo_the_bar' ) );
+        $this->assertTrue( current_user_can_for_site( $blog_id, 'edit_posts' ) );
+        $this->assertFalse( current_user_can_for_site( $blog_id, 'foo_the_bar' ) );
 
         $another_blog_id = self::factory()->blog->create( array( 'user_id' => self::$users['author']->ID ) );
@@ -1688 +1688 @@
 
         // Verify the user doesn't have a capability
-        $this->assertFalse( current_user_can_for_blog( $another_blog_id, 'edit_posts' ) );
+        $this->assertFalse( current_user_can_for_site( $another_blog_id, 'edit_posts' ) );
 
         // Add the current user to the site
@@ -1694 +1694 @@
 
         // Verify they now have the capability
-        $this->assertTrue( current_user_can_for_blog( $another_blog_id, 'edit_posts' ) );
+        $this->assertTrue( current_user_can_for_site( $another_blog_id, 'edit_posts' ) );
 
         wp_set_current_user( $old_uid );
@@ -1700 +1700 @@
 
     /**
-     * @group can_for_blog
-     */
-    public function test_user_can_for_blog() {
+     * @group can_for_site
+     */
+    public function test_user_can_for_site() {
         $user = self::$users['editor'];
 
-        $this->assertTrue( user_can_for_blog( $user->ID, get_current_blog_id(), 'edit_posts' ) );
-        $this->assertFalse( user_can_for_blog( $user->ID, get_current_blog_id(), 'foo_the_bar' ) );
+        $this->assertTrue( user_can_for_site( $user->ID, get_current_blog_id(), 'edit_posts' ) );
+        $this->assertFalse( user_can_for_site( $user->ID, get_current_blog_id(), 'foo_the_bar' ) );
 
         if ( ! is_multisite() ) {
-            $this->assertTrue( user_can_for_blog( $user->ID, 12345, 'edit_posts' ) );
-            $this->assertFalse( user_can_for_blog( $user->ID, 12345, 'foo_the_bar' ) );
+            $this->assertTrue( user_can_for_site( $user->ID, 12345, 'edit_posts' ) );
+            $this->assertFalse( user_can_for_site( $user->ID, 12345, 'foo_the_bar' ) );
             return;
         }
@@ -1717 +1717 @@
 
         $this->assertNotWPError( $blog_id );
-        $this->assertTrue( user_can_for_blog( $user->ID, $blog_id, 'edit_posts' ) );
-        $this->assertFalse( user_can_for_blog( $user->ID, $blog_id, 'foo_the_bar' ) );
+        $this->assertTrue( user_can_for_site( $user->ID, $blog_id, 'edit_posts' ) );
+        $this->assertFalse( user_can_for_site( $user->ID, $blog_id, 'foo_the_bar' ) );
 
         $author = self::$users['author'];
@@ -1724 +1724 @@
         // Verify another user doesn't have a capability
         $this->assertFalse( is_user_member_of_blog( $author->ID, $blog_id ) );
-        $this->assertFalse( user_can_for_blog( $author->ID, $blog_id, 'edit_posts' ) );
+        $this->assertFalse( user_can_for_site( $author->ID, $blog_id, 'edit_posts' ) );
 
         // Add the author to the site
@@ -1731 +1731 @@
         // Verify they now have the capability
         $this->assertTrue( is_user_member_of_blog( $author->ID, $blog_id ) );
-        $this->assertTrue( user_can_for_blog( $author->ID, $blog_id, 'edit_posts' ) );
+        $this->assertTrue( user_can_for_site( $author->ID, $blog_id, 'edit_posts' ) );
 
         // Verify the user doesn't have a capability for a non-existent site
-        $this->assertFalse( user_can_for_blog( $user->ID, -1, 'edit_posts' ) );
+        $this->assertFalse( user_can_for_site( $user->ID, -1, 'edit_posts' ) );
     }
 
@@ -1740 +1740 @@
      * @group ms-required
      */
-    public function test_borked_current_user_can_for_blog() {
+    public function test_borked_current_user_can_for_site() {
         $orig_blog_id = get_current_blog_id();
         $blog_id      = self::factory()->blog->create();
@@ -1748 +1748 @@
         add_action( 'switch_blog', array( $this, 'nullify_current_user_and_keep_nullifying_user' ) );
 
-        current_user_can_for_blog( $blog_id, 'edit_posts' );
+        current_user_can_for_site( $blog_id, 'edit_posts' );
 
         $this->assertSame( $orig_blog_id, get_current_blog_id() );