<!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][12925] trunk/src/bp-members: Member Invites: Add notifications.</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/12925">12925</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/12925","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:51:49 +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: Add notifications.
Add screen notifications for letting users know when their invitee
accepts an invitation.
See <a href="http://buddypress.trac.wordpress.org/ticket/8139">#8139</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersclassesclassbpmemberscomponentphp">trunk/src/bp-members/classes/class-bp-members-component.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersnotificationsphp">trunk/src/bp-members/bp-members-notifications.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersnotificationsphp"></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/bp-members-notifications.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-notifications.php (rev 0)
+++ trunk/src/bp-members/bp-members-notifications.php 2021-04-28 23:51:49 UTC (rev 12925)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,231 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * BuddyPress Members Activity Functions.
+ *
+ * These functions handle the recording, deleting and formatting of activity
+ * for the user and for this specific component.
+ *
+ * @package BuddyPress
+ * @subpackage MembersNotifications
+ * @since 8.0.0
+ */
+
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Notification formatting callback for bp-members notifications.
+ *
+ * @since 8.0.0
+ *
+ * @param string $action The kind of notification being rendered.
+ * @param int $item_id The primary item ID.
+ * @param int $secondary_item_id The secondary item ID.
+ * @param int $total_items The total number of members-related notifications
+ * waiting for the user.
+ * @param string $format 'string' for BuddyBar-compatible notifications;
+ * 'array' for WP Toolbar. Default: 'string'.
+ * @return array|string
+ */
+function members_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
+
+ switch ( $action ) {
+ case 'accepted_invitation':
+
+ // Set up the string and the filter.
+ if ( (int) $total_items > 1 ) {
+ $link = bp_get_notifications_permalink();
+ $amount = 'multiple';
+
+ // This is the inviter whose invitation was accepted.
+ if ( 0 !== (int) $secondary_item_id ) {
+ /* translators: %d: the number of new users */
+ $text = sprintf( __( '%d members accepted your membership invitations', 'buddypress' ), (int) $total_items );
+ // This is someone who also invited that user to join.
+ } else {
+ /* translators: %d: the number of new users */
+ $text = sprintf( __( '%d members are now members of the site', 'buddypress' ), (int) $total_items );
+ }
+ } else {
+ $link = add_query_arg( 'welcome', 1, bp_core_get_user_domain( $item_id ) );
+ $amount = 'single';
+
+ // This is the inviter whose invitation was accepted.
+ if ( 0 !== (int) $secondary_item_id ) {
+ /* translators: %s: new user name */
+ $text = sprintf( __( '%s accepted your membership invitation', 'buddypress' ), bp_core_get_user_displayname( $item_id ) );
+ // This is someone who also invited that user to join.
+ } else {
+ /* translators: %s: new user name */
+ $text = sprintf( __( '%s is now a member of the site', 'buddypress' ), bp_core_get_user_displayname( $item_id ) );
+ }
+ }
+ break;
+ }
+
+ // Return either an HTML link or an array, depending on the requested format.
+ if ( 'string' == $format ) {
+
+ /**
+ * Filters the format of members notifications based on type and amount * of notifications pending.
+ *
+ * This is a variable filter that has several versions.
+ * The possible versions are:
+ * - bp_members_single_accepted_invitation_notification
+ * - bp_members_multiple_accepted_invitation_notification
+ *
+ * @since 8.0.0
+ *
+ * @param string|array $value Depending on format, an HTML link to new requests profile tab or array with link and text.
+ * @param int $total_items The total number of messaging-related notifications waiting for the user.
+ * @param int $item_id The primary item ID.
+ * @param int $secondary_item_id The secondary item ID.
+ */
+ $return = apply_filters( 'bp_members_' . $amount . '_'. $action . '_notification', '<a href="' . esc_url( $link ) . '">' . esc_html( $text ) . '</a>', (int) $total_items, $item_id, $secondary_item_id );
+ } else {
+ /** This filter is documented in bp-members/bp-members-notifications.php */
+ $return = apply_filters( 'bp_members_' . $amount . '_'. $action . '_notification', array(
+ 'link' => $link,
+ 'text' => $text
+ ), (int) $total_items, $item_id, $secondary_item_id );
+ }
+
+ /**
+ * Fires at the end of the bp-members notification format callback.
+ *
+ * @since 8.0.0
+ *
+ * @param string $action The kind of notification being rendered.
+ * @param int $item_id The primary item ID.
+ * @param int $secondary_item_id The secondary item ID.
+ * @param int $total_items The total number of members-related notifications
+ * waiting for the user.
+ * @param array|string $return Notification text string or array of link and text.
+ */
+ do_action( 'members_format_notifications', $action, $item_id, $secondary_item_id, $total_items, $return );
+
+ return $return;
+}
+
+/**
+ * Notify one use that another user has accepted their site membership invitation.
+ *
+ * @since 8.0.0
+ *
+ * @param BP_Invitation $invite Invitation that was accepted.
+ * @param WP_user $new_user User who accepted the membership invite.
+ * @param int $inviter_id ID of the user who invited this user to the site.
+ */
+function bp_members_invitations_accepted_invitation_notification( $invite, $new_user, $inviter_id ) {
+
+ // Notify all inviters.
+ $args = array(
+ 'invitee_email' => $new_user->user_email,
+ 'accepted' => 'all',
+ );
+ $invites = bp_members_invitations_get_invites( $args );
+
+ if ( ! $invites ) {
+ return;
+ }
+ foreach ( $invites as $invite) {
+ // Include the id of the "accepted" invitation.
+ if ( $invite->inviter_id === $inviter_id ) {
+ $secondary_item_id = $invite->id;
+ } else {
+ // Else don't store the invite id, so we know this is not the primary.
+ $secondary_item_id = 0;
+ }
+ $res = bp_notifications_add_notification( array(
+ 'user_id' => $invite->inviter_id,
+ 'item_id' => $new_user->ID,
+ 'secondary_item_id' => $secondary_item_id,
+ 'component_name' => buddypress()->members->id,
+ 'component_action' => 'accepted_invitation',
+ 'date_notified' => bp_core_current_time(),
+ 'is_new' => 1,
+ ) );
+ }
+}
+add_action( 'community_membership_invite_accepted', 'bp_members_invitations_accepted_invitation_notification', 10, 3 );
+
+/**
+ * Mark accepted invitation notifications as read when user visits new user profile.
+ *
+ *
+ * @since 8.0.0
+ */
+function bp_members_mark_read_accepted_invitation_notification() {
+ if ( false === is_singular() || false === is_user_logged_in() || ! bp_is_user() || empty( $_GET['welcome'] ) ) {
+ return;
+ }
+
+ // Mark notification as read.
+ BP_Notifications_Notification::update(
+ array(
+ 'is_new' => false
+ ),
+ array(
+ 'user_id' => bp_loggedin_user_id(),
+ 'item_id' => bp_displayed_user_id(),
+ )
+ );
+}
+add_action( 'bp_screens', 'bp_members_mark_read_accepted_invitation_notification' );
+
+/**
+ * Add Members-related settings to the Settings > Notifications page.
+ *
+ * @since 8.0.0
+ */
+function members_screen_notification_settings() {
+
+ // Bail early if invitations are not allowed--they are the only members notification so far.
+ if ( ! bp_get_members_invitations_allowed () ) {
+ return;
+ }
+
+ if ( ! $allow_acceptance_emails = bp_get_user_meta( bp_displayed_user_id(), 'notification_members_invitation_accepted', true ) ) {
+ $allow_acceptance_emails = 'yes';
+ }
+ ?>
+
+ <table class="notification-settings" id="members-notification-settings">
+ <thead>
+ <tr>
+ <th class="icon"></th>
+ <th class="title"><?php _ex( 'Members', 'Member settings on notification settings page', 'buddypress' ) ?></th>
+ <th class="yes"><?php _e( 'Yes', 'buddypress' ) ?></th>
+ <th class="no"><?php _e( 'No', 'buddypress' )?></th>
+ </tr>
+ </thead>
+
+ <tbody>
+ <tr id="members-notification-settings-invitation_accepted">
+ <td></td>
+ <td><?php _ex( 'Someone accepts your membership invitation', 'Member settings on notification settings page', 'buddypress' ) ?></td>
+ <td class="yes"><input type="radio" name="notifications[notification_members_invitation_accepted]" id="notification-members-invitation-accepted-yes" value="yes" <?php checked( $allow_acceptance_emails, 'yes', true ) ?>/><label for="notification-members-invitation-accepted-yes" class="bp-screen-reader-text"><?php
+ /* translators: accessibility text */
+ _e( 'Yes, send email', 'buddypress' );
+ ?></label></td>
+ <td class="no"><input type="radio" name="notifications[notification_members_invitation_accepted]" id="notification-members-invitation-accepted-no" value="no" <?php checked( $allow_acceptance_emails, 'no', true ) ?>/><label for="notification-members-invitation-accepted-no" class="bp-screen-reader-text"><?php
+ /* translators: accessibility text */
+ _e( 'No, do not send email', 'buddypress' );
+ ?></label></td>
+ </tr>
+
+ <?php
+
+ /**
+ * Fires after the last table row on the members notification screen.
+ *
+ * @since 1.0.0
+ */
+ do_action( 'members_screen_notification_settings' ); ?>
+
+ </tbody>
+ </table>
+
+<?php
+}
+add_action( 'bp_notification_settings', 'members_screen_notification_settings' );
</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:51:37 UTC (rev 12924)
+++ trunk/src/bp-members/classes/class-bp-members-component.php 2021-04-28 23:51:49 UTC (rev 12925)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,6 +66,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'widgets',
</span><span class="cx" style="display: block; padding: 0 10px"> 'cache',
</span><span class="cx" style="display: block; padding: 0 10px"> 'invitations',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'notifications',
</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">@@ -191,7 +192,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'table_name_last_activity' => bp_core_get_table_prefix() . 'bp_activity',
</span><span class="cx" style="display: block; padding: 0 10px"> 'table_name_optouts' => bp_core_get_table_prefix() . 'bp_optouts',
</span><span class="cx" style="display: block; padding: 0 10px"> 'table_name_signups' => $wpdb->base_prefix . 'signups', // Signups is a global WordPress table.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ),
+ 'notification_callback' => 'members_format_notifications',
</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"> parent::setup_globals( $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,7 +486,6 @@
</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">-
</del><span class="cx" style="display: block; padding: 0 10px"> parent::setup_nav( $main_nav, $sub_nav );
</span><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>