Changeset 9957 for trunk/src/bp-core/bp-core-caps.php

Timestamp:

06/20/2015 01:54:56 PM (10 years ago)

Author:

boonebgorges

Message:

Convert second parameter of bp_current_user_can() to an $args array.

This makes the syntax simpler for the vast majority of use cases, where an
explicit blog_id doesn't need to be specified. It also makes it possible to
pass additional arguments, such as an item_id, to bp_current_user_can().

An integer passed as the second parameter will trigger the backward-
compatibility layer.

Props thebrandonallen, r-a-y.
See #5121. Fixes #6501.

File:

• trunk/src/bp-core/bp-core-caps.php (modified) (3 diffs)

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

@@ -264 +264 @@
  * Check whether the current user has a given capability.
  *
- * Can be passed blog ID, or will use the root blog by default.
- *
- * @since BuddyPress (1.6.0)
- *
- * @param string $capability Capability or role name.
- * @param int $blog_id Optional. Blog ID. Defaults to the BP root blog.
- * @return bool True if the user has the cap for the given blog.
- */
-function bp_current_user_can( $capability, $blog_id = 0 ) {
+ * @since BuddyPress (1.6.0)
+ * @since BuddyPress (2.4.0) Second argument modified to accept an array, rather than `$blog_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 mixed $a,...   Optional. Extra arguments applicable to the capability check.
+ * }
+ * @return bool True if the user has the cap for the given parameters.
+ */
+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();
+
+    // 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'];
+        unset( $args['blog_id'] );
+    }
 
     // Use root blog if no ID passed
@@ -279 +295 @@
     }
 
-    $retval = current_user_can_for_blog( $blog_id, $capability );
+    $args   = array( $blog_id, $capability, $args );
+    $retval = call_user_func_array( 'current_user_can_for_blog', $args );
 
     /**
@@ -285 +302 @@
      *
      * @since BuddyPress (1.6.0)
+     * @since BuddyPress (2.4.0) Pass `$args` variable.
      *
      * @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.
-     */
-    return (bool) apply_filters( 'bp_current_user_can', $retval, $capability, $blog_id );
+     * @param array  $args       Array of extra arguments passed.
+     */
+    return (bool) apply_filters( 'bp_current_user_can', $retval, $capability, $blog_id, $args );
 }