<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][9957] trunk: Convert second parameter of `bp_current_user_can()` to an `$args` array.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9957">9957</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9957","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-06-20 13:54:56 +0000 (Sat, 20 Jun 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/ticket/5121">#5121</a>. Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6501">#6501</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorecapsphp">trunk/src/bp-core/bp-core-caps.php</a></li>
<li><a href="#trunktestsphpunittestcasescorecapsphp">trunk/tests/phpunit/testcases/core/caps.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorecapsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-caps.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-caps.php 2015-06-20 13:41:23 UTC (rev 9956)
+++ trunk/src/bp-core/bp-core-caps.php 2015-06-20 13:54:56 UTC (rev 9957)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -263,33 +263,52 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Check whether the current user has a given capability.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Can be passed blog ID, or will use the root blog by default.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.6.0)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (2.4.0) Second argument modified to accept an array, rather than `$blog_id`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_current_user_can( $capability, $blog_id = 0 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_current_user_can( $capability, $args = array() ) {
+ $blog_id = 0;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Use root blog if no ID passed
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $blog_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = bp_get_root_blog_id();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $retval = current_user_can_for_blog( $blog_id, $capability );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array( $blog_id, $capability, $args );
+ $retval = call_user_func_array( 'current_user_can_for_blog', $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether or not the current user has a given capability.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.6.0)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (2.4.0) Pass `$args` variable.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $retval Whether or not the current user has the capability.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $capability The capability being checked for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $blog_id Blog ID. Defaults to the BP root blog.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Array of extra arguments passed.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return (bool) apply_filters( 'bp_current_user_can', $retval, $capability, $blog_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return (bool) apply_filters( 'bp_current_user_can', $retval, $capability, $blog_id, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestcasescorecapsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/core/caps.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/caps.php 2015-06-20 13:41:23 UTC (rev 9956)
+++ trunk/tests/phpunit/testcases/core/caps.php 2015-06-20 13:54:56 UTC (rev 9957)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,6 +24,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $cant );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket BP6501
+ */
+ public function test_bp_current_user_can_should_respect_blog_id_passed_in_args_array() {
+ if ( ! is_multisite() ) {
+ $this->markTestSkipped( __METHOD__ . ' requires multisite.' );
+ }
+
+ $b = $this->factory->blog->create();
+ $u = $this->factory->user->create();
+
+ $this->set_current_user( $u );
+
+ add_filter( 'user_has_cap', array( $this, 'grant_cap_foo' ), 10, 2 );
+ $can = bp_current_user_can( 'foo', array( 'blog_id' => bp_get_root_blog_id() ) );
+ $cant = bp_current_user_can( 'foo', array( 'blog_id' => $b ) );
+ remove_filter( 'user_has_cap', array( $this, 'grant_cap_foo' ), 10, 2 );
+
+ $this->assertTrue( $can );
+ $this->assertFalse( $cant );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function grant_cap_foo( $allcaps, $caps ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_root_blog() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $allcaps['foo'] = 1;
</span></span></pre>
</div>
</div>
</body>
</html>