Changeset 11052

Timestamp:

09/01/2016 12:50:06 AM (4 years ago)

Author:

dcavins

Message:

Improve bp_current_user_can().

• Deprecate $args['blog_id’] in favor of $args['site_id’].
• Improve the structure of the passed $args array in the

bp_current_user_can filter.

Props r-a-y, dcavins.

Fixes #7192.

Location:

trunk

Files:

• src/bp-core/bp-core-caps.php (modified) (4 diffs)
• src/bp-xprofile/bp-xprofile-caps.php (modified) (1 diff)
• tests/phpunit/testcases/core/caps.php (modified) (1 diff)

trunk/src/bp-core/bp-core-caps.php

@@ -244 +244 @@
  * @since 1.6.0
  * @since 2.4.0 Second argument modified to accept an array, rather than `$blog_id`.
+ * @since 2.7.0 Deprecated $args['blog_id'] in favor of $args['site_id'].
  *
  * @param string    $capability Capability or role name.
  * @param array|int $args {
  *     Array of extra arguments applicable to the capability check.
- *     @type int   $blog_id Optional. Blog ID. Defaults to the BP root blog.
+ *     @type int   $site_id Optional. Blog ID. Defaults to the BP root blog.
+ *     @type int   $blog_id Deprecated. Use $site_id instead.
  *     @type mixed $a,...   Optional. Extra arguments applicable to the capability check.
  * }
@@ -254 +256 @@
  */
 function bp_current_user_can( $capability, $args = array() ) {
-    $blog_id = 0;
-
     // Backward compatibility for older $blog_id parameter.
     if ( is_int( $args ) ) {
         $blog_id = $args;
         $args = array();
+        $args['site_id'] = $args;
 
     // New format for second parameter.
     } elseif ( is_array( $args ) && isset( $args['blog_id'] ) ) {
         // Get the blog ID if set, but don't pass along to `current_user_can_for_blog()`.
-        $blog_id = (int) $args['blog_id'];
+        $args['site_id'] = (int) $args['blog_id'];
         unset( $args['blog_id'] );
     }
 
-    // Backward compatibility for older bp_current_user_can() checks.
-    if ( empty( $args ) ) {
-        $args = null;
-    }
+    // Cast $args as an array.
+    $args = (array) $args;
 
     // Use root blog if no ID passed.
-    if ( empty( $blog_id ) ) {
-        $blog_id = bp_get_root_blog_id();
-    }
-
-    $args   = array( $blog_id, $capability, $args );
-    $retval = call_user_func_array( 'current_user_can_for_blog', $args );
+    if ( empty( $args['site_id'] ) ) {
+        $args['site_id'] = bp_get_root_blog_id();
+    }
+
+    // Call bp_user_can().
+    $retval = bp_user_can( bp_loggedin_user_id(), $capability, $args );
 
     /**
@@ -286 +285 @@
      * @since 1.6.0
      * @since 2.4.0 Pass `$args` variable.
+     * @since 2.7.0 Change format of $args variable array.
      *
      * @param bool   $retval     Whether or not the current user has the capability.
      * @param string $capability The capability being checked for.
      * @param int    $blog_id    Blog ID. Defaults to the BP root blog.
-     * @param array  $args       Array of extra arguments passed.
-     */
-    return (bool) apply_filters( 'bp_current_user_can', $retval, $capability, $blog_id, $args );
+     * @param array  $args       Array of extra arguments as originally passed.
+     */
+    return (bool) apply_filters( 'bp_current_user_can', $retval, $capability, $args['site_id'], $args );
 }
 
@@ -320 +320 @@
 
     $switched = is_multisite() ? switch_to_blog( $site_id ) : false;
-    $args     = array( $user_id, $capability, $args );
-    $retval   = call_user_func_array( 'user_can', $args );
+    $retval   = call_user_func_array( 'user_can', array( $user_id, $capability, $args ) );
 
     /**

trunk/src/bp-xprofile/bp-xprofile-caps.php

@@ -29 +29 @@
 
             // You may pass args manually: $field_id, $profile_user_id.
-            $field_id        = isset( $args[0] ) ? (int)$args[0] : bp_get_the_profile_field_id();
-            $profile_user_id = isset( $args[1] ) ? (int)$args[1] : bp_displayed_user_id();
+            $field_id        = ! empty( $args[0] ) ? (int) $args[0] : bp_get_the_profile_field_id();
+            $profile_user_id = isset( $args[1] )   ? (int) $args[1] : bp_displayed_user_id();
 
             // Visibility on the fullname field is not editable.

trunk/tests/phpunit/testcases/core/caps.php

@@ -47 +47 @@
     }
 
-    /**
-     * @group bp_xprofile_change_field_visibility
-     */
-    public function test_bp_current_user_can_should_pass_null_in_args_parameter_if_empty() {
-        $u = $this->factory->user->create();
-        $this->set_current_user( $u );
-
-        /**
-         * Fake bp_get_the_profile_field_id() to pretend we're in the field loop and
-         * to avoid notices when checking 'bp_xprofile_change_field_visibility' cap
-         */
-        $GLOBALS['field'] = new stdClass;
-        $GLOBALS['field']->id = 1;
-
-        // Capture the cap's $args
-        add_filter( 'bp_xprofile_map_meta_caps', array( $this, 'check_cap_args' ), 10, 4 );
-
-        // Use a cap check that depends on a null value for a cap's args
-        bp_current_user_can( 'bp_xprofile_change_field_visibility' );
-
-        // Assert!
-        $this->assertEquals( null, $this->test_args[0] );
-
-        // Reset
-        remove_filter( 'bp_xprofile_map_meta_caps', array( $this, 'check_cap_args' ), 10, 4 );
-        unset( $GLOBALS['field'], $this->test_args );
-    }
-
     public function grant_cap_foo( $allcaps, $caps ) {
         if ( bp_is_root_blog() ) {