<!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][9293] trunk: Add `$user_id` parameter to `bp_groups_user_can_send_invites()`.</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/9293">9293</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/9293","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-01-02 04:32:04 +0000 (Fri, 02 Jan 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'>Add `$user_id` parameter to `bp_groups_user_can_send_invites()`.
This allows developers to check if a specific user can send group invites
rather than just do checks against the logged-in user.
This commit also:
* Updates the PHPDoc for the function and the filter hook.
* Adds unit tests.
Props dcavins.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6031">#6031</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupstemplatephp">trunk/src/bp-groups/bp-groups-template.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsclassbpgroupsmemberphp">trunk/tests/phpunit/testcases/groups/class-bp-groups-member.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-template.php 2014-12-31 20:48:50 UTC (rev 9292)
+++ trunk/src/bp-groups/bp-groups-template.php 2015-01-02 04:32:04 UTC (rev 9293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1881,58 +1881,70 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Can the logged-in user send invitations in the specified group?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Can a user send invitations in the specified group?
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.5.0)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (2.2.0) Added the $user_id parameter.
</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 int $group_id Optional. The ID of the group whose status you want to
- * check. Default: the ID of the current group.
- * @return bool $can_send_invites
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $group_id The group ID to check.
+ * @param int $user_id The user ID to check.
+ * @return bool
</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_groups_user_can_send_invites( $group_id = false ) {
- global $bp;
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_groups_user_can_send_invites( $group_id = 0, $user_id = 0 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $can_send_invites = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $invite_status = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_user_logged_in() ) {
- if ( bp_current_user_can( 'bp_moderate' ) ) {
- // Super admins can always send invitations
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If $user_id isn't specified, we check against the logged-in user.
+ if ( ! $user_id ) {
+ $user_id = bp_loggedin_user_id();
+ }
+
+ // If $group_id isn't specified, use existing one if available.
+ if ( ! $group_id ) {
+ $group_id = bp_get_current_group_id();
+ }
+
+ if ( $user_id ) {
+ // Users with the 'bp_moderate' cap can always send invitations
+ if ( user_can( $user_id, 'bp_moderate' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $can_send_invites = true;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If no $group_id is provided, default to the current group id
- if ( !$group_id )
- $group_id = isset( $bp->groups->current_group->id ) ? $bp->groups->current_group->id : 0;
-
- // If no group has been found, bail
- if ( !$group_id )
- return false;
-
</del><span class="cx" style="display: block; padding: 0 10px"> $invite_status = bp_group_get_invite_status( $group_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !$invite_status )
- return false;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $invite_status ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'admins' :
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( groups_is_user_admin( bp_loggedin_user_id(), $group_id ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( groups_is_user_admin( $user_id, $group_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $can_send_invites = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'mods' :
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( groups_is_user_mod( bp_loggedin_user_id(), $group_id ) || groups_is_user_admin( bp_loggedin_user_id(), $group_id ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( groups_is_user_mod( $user_id, $group_id ) || groups_is_user_admin( $user_id, $group_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $can_send_invites = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'members' :
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( groups_is_user_member( bp_loggedin_user_id(), $group_id ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( groups_is_user_member( $user_id, $group_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $can_send_invites = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><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 class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'bp_groups_user_can_send_invites', $can_send_invites, $group_id, $invite_status );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether a user can send invites in a group.
+ *
+ * @since BuddyPress (1.5.0)
+ * @since BuddyPress (2.2.0) Added the $user_id parameter.
+ *
+ * @param bool $can_send_invites Whether the user can send invites
+ * @param int $group_id The group ID being checked
+ * @param bool $invite_status The group's current invite status
+ * @param int $user_id The user ID being checked
+ */
+ return apply_filters( 'bp_groups_user_can_send_invites', $can_send_invites, $group_id, $invite_status, $user_id );
</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="trunktestsphpunittestcasesgroupsclassbpgroupsmemberphp"></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/groups/class-bp-groups-member.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/class-bp-groups-member.php 2014-12-31 20:48:50 UTC (rev 9292)
+++ trunk/tests/phpunit/testcases/groups/class-bp-groups-member.php 2015-01-02 04:32:04 UTC (rev 9293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,5 +127,95 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $ids = wp_list_pluck( $mm, 'user_id' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $u2 ), $ids );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group bp_groups_user_can_send_invites
+ */
+ public function test_bp_groups_user_can_send_invites() {
+ $u_members = $this->factory->user->create();
+ $u_mods = $this->factory->user->create();
+ $u_admins = $this->factory->user->create();
+ $u_siteadmin = $this->factory->user->create();
+ $user_siteadmin = new WP_User( $u_siteadmin );
+ $user_siteadmin->add_role( 'administrator' );
+
+ $g = $this->factory->group->create();
+
+ $now = time();
+ $old_current_user = get_current_user_id();
+
+ // Create member-level user
+ $this->add_user_to_group( $u_members, $g, array(
+ 'date_modified' => date( 'Y-m-d H:i:s', $now - 60 ),
+ ) );
+ // Create mod-level user
+ $this->add_user_to_group( $u_mods, $g, array(
+ 'date_modified' => date( 'Y-m-d H:i:s', $now - 60 ),
+ ) );
+ $m_mod = new BP_Groups_Member( $u_mods, $g );
+ $m_mod->promote( 'mod' );
+ // Create admin-level user
+ $this->add_user_to_group( $u_admins, $g, array(
+ 'date_modified' => date( 'Y-m-d H:i:s', $now - 60 ),
+ ) );
+ $m_admin = new BP_Groups_Member( $u_admins, $g );
+ $m_admin->promote( 'admin' );
+
+ // Test with no status
+ // In bp_group_get_invite_status(), no status falls back to "members"
+ $this->assertTrue( '' == groups_get_groupmeta( $g, 'invite_status' ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_members ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_mods ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_admins ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_siteadmin ) );
+
+ // Test with members status
+ groups_update_groupmeta( $g, 'invite_status', 'members' );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_members ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_mods ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_admins ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_siteadmin ) );
+ // Falling back to current user
+ $this->set_current_user( $u_members );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, null ) );
+
+ // Test with mod status
+ groups_update_groupmeta( $g, 'invite_status', 'mods' );
+ $this->assertFalse( bp_groups_user_can_send_invites( $g, $u_members ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_mods ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_admins ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_siteadmin ) );
+ // Falling back to current user
+ $this->set_current_user( $u_members );
+ $this->assertFalse( bp_groups_user_can_send_invites( $g, null ) );
+ $this->set_current_user( $u_mods );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, null ) );
+
+ // Test with admin status
+ groups_update_groupmeta( $g, 'invite_status', 'admins' );
+ $this->assertFalse( bp_groups_user_can_send_invites( $g, $u_members ) );
+ $this->assertFalse( bp_groups_user_can_send_invites( $g, $u_mods ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_admins ) );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, $u_siteadmin ) );
+ // Falling back to current user
+ $this->set_current_user( $u_mods );
+ $this->assertFalse( bp_groups_user_can_send_invites( $g, null ) );
+ $this->set_current_user( $u_admins );
+ $this->assertTrue( bp_groups_user_can_send_invites( $g, null ) );
+
+ // Bad or null parameters
+ $this->assertFalse( bp_groups_user_can_send_invites( 59876454257, $u_members ) );
+ $this->assertFalse( bp_groups_user_can_send_invites( $g, 958647515 ) );
+ // Not in group context
+ $this->assertFalse( bp_groups_user_can_send_invites( null, $u_members ) );
+ // In group context
+ $g_obj = groups_get_group( array( 'group_id' => $g ) );
+ $this->go_to( bp_get_group_permalink( $g_obj ) );
+ groups_update_groupmeta( $g, 'invite_status', 'members' );
+
+ $this->assertTrue( bp_groups_user_can_send_invites( null, $u_members ) );
+
+ $this->set_current_user( $old_current_user );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>