<!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][12917] trunk/src: Member Invites: Introduce BP_Members_Invitation_Manager.</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 { white-space: pre-line; 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/12917">12917</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/12917","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-04-28 23:50:09 +0000 (Wed, 28 Apr 2021)</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'>Member Invites: Introduce BP_Members_Invitation_Manager.
Introduce new BP_Members_Invitation_Manager class, `bp_user_can` filter.
See <a href="http://buddypress.trac.wordpress.org/ticket/8139">#8139</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersfiltersphp">trunk/src/bp-members/bp-members-filters.php</a></li>
<li><a href="#trunksrcbpmembersclassesclassbpmemberscomponentphp">trunk/src/bp-members/classes/class-bp-members-component.php</a></li>
<li><a href="#trunksrcclassbuddypressphp">trunk/src/class-buddypress.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersclassesclassbpmembersinvitationmanagerphp">trunk/src/bp-members/classes/class-bp-members-invitation-manager.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-filters.php 2021-04-28 23:49:56 UTC (rev 12916)
+++ trunk/src/bp-members/bp-members-filters.php 2021-04-28 23:50:09 UTC (rev 12917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,3 +127,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_members_edit_profile_url', $profile_link, $url, $user_id, $scheme );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'edit_profile_url', 'bp_members_edit_profile_url', 10, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Filter the bp_user_can value to determine what the user can do in the members component.
+ *
+ * @since 8.0.0
+ *
+ * @param bool $retval Whether or not the current user has the capability.
+ * @param int $user_id
+ * @param string $capability The capability being checked for.
+ * @param int $site_id Site ID. Defaults to the BP root blog.
+ * @param array $args Array of extra arguments passed.
+ *
+ * @return bool
+ */
+function bp_members_user_can_filter( $retval, $user_id, $capability, $site_id, $args = array() ) {
+
+ switch ( $capability ) {
+ case 'bp_members_manage_membership_requests':
+ $retval = bp_user_can( $user_id, 'bp_moderate' );
+ break;
+
+ case 'bp_members_send_invitation':
+ if ( bp_get_members_invitations_allowed() ) {
+ $retval = true;
+ }
+ break;
+
+ case 'bp_members_receive_invitation':
+ if ( bp_get_members_invitations_allowed() ) {
+ $retval = true;
+ // The invited user must not already be a member of the network.
+ if ( empty( $args['invitee_email'] ) || false !== get_user_by( 'email', $args['invitee_email'] ) ) {
+ $retval = false;
+ }
+ // The invited user must not have opted out from being contacted from this site.
+ if ( bp_user_has_opted_out( $args['invitee_email'] ) ) {
+ $retval = false;
+ }
+ }
+ break;
+ }
+
+ return $retval;
+}
+add_filter( 'bp_user_can', 'bp_members_user_can_filter', 10, 5 );
</ins></span></pre></div>
<a id="trunksrcbpmembersclassesclassbpmemberscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/classes/class-bp-members-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-members-component.php 2021-04-28 23:49:56 UTC (rev 12916)
+++ trunk/src/bp-members/classes/class-bp-members-component.php 2021-04-28 23:50:09 UTC (rev 12917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,7 +39,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> buddypress()->plugin_dir,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'adminbar_myaccount_order' => 20,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'search_query_arg' => 'members_search',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_query_arg' => 'members_search',
+ 'features' => array( 'invitations' )
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,6 +65,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'blocks',
</span><span class="cx" style="display: block; padding: 0 10px"> 'widgets',
</span><span class="cx" style="display: block; padding: 0 10px"> 'cache',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'invitations',
</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"> if ( bp_is_active( 'activity' ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -233,6 +235,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bp->profile->slug = 'profile';
</span><span class="cx" style="display: block; padding: 0 10px"> $bp->profile->id = 'profile';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /** Network Invitations **************************************************
+ */
+
+ $bp->members->invitations = new stdClass;
</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="trunksrcbpmembersclassesclassbpmembersinvitationmanagerphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/bp-members/classes/class-bp-members-invitation-manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-members-invitation-manager.php (rev 0)
+++ trunk/src/bp-members/classes/class-bp-members-invitation-manager.php 2021-04-28 23:50:09 UTC (rev 12917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,178 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Membership invitations class.
+ *
+ * @package BuddyPress
+ * @subpackage Core
+ * @since 8.0.0
+ */
+
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Membership invitations class.
+ *
+ * An extension of the core Invitations class that adapts the
+ * core logic to accommodate site membership invitation behavior.
+ *
+ * @since 8.0.0
+ */
+class BP_Members_Invitation_Manager extends BP_Invitation_Manager {
+ /**
+ * Construct parameters.
+ *
+ * @since 8.0.0
+ *
+ * @param array|string $args.
+ */
+ public function __construct( $args = '' ) {
+ parent::__construct();
+ }
+
+ /**
+ * This is where custom actions are added to run when notifications of an
+ * invitation or request need to be generated & sent.
+ *
+ * @since 8.0.0
+ *
+ * @param obj BP_Invitation $invitation The invitation to send.
+ * @return bool True on success, false on failure.
+ */
+ public function run_send_action( BP_Invitation $invitation ) {
+ // Notify site admins of the pending request
+ if ( 'request' === $invitation->type ) {
+ // Coming soon to a BuddyPress near you!
+ return true;
+ // Notify the invitee of the invitation.
+ } else {
+ // Stop if the invitation has already been accepted.
+ if ( $invitation->accepted ) {
+ return false;
+ }
+
+ $inviter_ud = bp_core_get_core_userdata( $invitation->inviter_id );
+
+ $invite_url = esc_url(
+ add_query_arg(
+ array(
+ 'inv' => $invitation->id,
+ 'ih' => bp_members_invitations_get_hash( $invitation ),
+ ),
+ bp_get_signup_page()
+ )
+ );
+ $unsubscribe_args = array(
+ 'user_id' => 0,
+ 'email_address' => $invitation->invitee_email,
+ 'member_id' => $invitation->inviter_id,
+ 'notification_type' => 'bp-members-invitation',
+ );
+
+ $args = array(
+ 'tokens' => array(
+ 'inviter.name' => bp_core_get_userlink( $invitation->inviter_id, true, false, true ),
+ 'inviter.url' => bp_core_get_user_domain( $invitation->inviter_id ),
+ 'inviter.id' => $invitation->inviter_id,
+ 'invite.accept_url' => esc_url( $invite_url ),
+ 'usermessage' => wp_kses( $invitation->content, array() ),
+ 'unsubscribe' => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
+ ),
+ );
+
+ return bp_send_email( 'bp-members-invitation', $invitation->invitee_email, $args );
+ }
+ }
+
+ /**
+ * This is where custom actions are added to run when an invitation
+ * or request is accepted.
+ *
+ * @since 8.0.0
+ *
+ * @param string $type Are we accepting an invitation or request?
+ * @param array $r Parameters that describe the invitation being accepted.
+ * @return bool True on success, false on failure.
+ */
+ public function run_acceptance_action( $type, $r ) {
+ if ( ! $type || ! in_array( $type, array( 'request', 'invite' ), true ) ) {
+ return false;
+ }
+
+ if ( 'invite' === $type ) {
+
+ $invites = $this->get_invitations( $r );
+ if ( ! $invites ) {
+ return;
+ }
+
+ foreach ( $invites as $invite ) {
+ // Add the accepted invitation ID to the user's meta.
+ $new_user = get_user_by( 'email', $invite->invitee_email );
+ bp_update_user_meta( $new_user->ID, 'accepted_members_invitation', $invite->id );
+
+ // We will mark all invitations to this user as "accepted."
+ if ( ! empty( $invite->invitee_email ) ) {
+ $args = array(
+ 'invitee_email' => $invite->invitee_email,
+ 'item_id' => get_current_network_id(),
+ 'type' => 'all'
+ );
+ $this->mark_accepted( $args );
+ }
+
+ /**
+ * Fires after a user has accepted a site membership invite.
+ *
+ * @since 8.0.0
+ *
+ * @param BP_Invitation $invite Invitation that was accepted.
+ * @param WP_user $new_user ID of the user who accepted the membership invite.
+ * @param int $inviter_id ID of the user who invited this user to the site.
+ */
+ do_action( 'community_membership_invite_accepted', $invite, $new_user, $invite->inviter_id );
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Should this invitation be created?
+ *
+ * @since 8.0.0
+ *
+ * @param array $args.
+ * @return bool
+ */
+ public function allow_invitation( $args ) {
+ // Does the inviter have this capability?
+ if ( ! bp_user_can( $args['inviter_id'], 'bp_members_send_invitation' ) ) {
+ return false;
+ }
+
+ // Is the invited user eligible to receive an invitation? Hasn't opted out?
+ if ( ! bp_user_can( 0, 'bp_members_receive_invitation', $args ) ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Should this request be created?
+ *
+ * @since 8.0.0
+ *
+ * @param array $args.
+ * @return bool.
+ */
+ public function allow_request( $args ) {
+ // Does the requester have this capability?
+ if ( ! bp_user_can( 0, 'bp_network_request_membership', $args ) ) {
+ return false;
+ }
+
+ return true;
+ }
+}
</ins></span></pre></div>
<a id="trunksrcclassbuddypressphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/class-buddypress.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/class-buddypress.php 2021-04-28 23:49:56 UTC (rev 12916)
+++ trunk/src/class-buddypress.php 2021-04-28 23:50:09 UTC (rev 12917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -622,6 +622,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Attachments_Member_Avatar_Endpoint' => 'members',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Attachments_Member_Cover_Endpoint' => 'members',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Signup_Endpoint' => 'members',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'BP_Members_Invitation_Manager' => 'members',
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Messages_Endpoint' => 'messages',
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>