<!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][9175] trunk/src/bp-friends/bp-friends-notifications.php: Add hook documentation in bp-friends-notifications.php.</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/9175">9175</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/9175","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>2014-11-25 15:00:37 +0000 (Tue, 25 Nov 2014)</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 hook documentation in bp-friends-notifications.php.
Props tw2113.
See <a href="http://buddypress.trac.wordpress.org/ticket/5942">#5942</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpfriendsbpfriendsnotificationsphp">trunk/src/bp-friends/bp-friends-notifications.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpfriendsbpfriendsnotificationsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/bp-friends-notifications.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-notifications.php 2014-11-25 14:51:59 UTC (rev 9174)
+++ trunk/src/bp-friends/bp-friends-notifications.php 2014-11-25 15:00:37 UTC (rev 9175)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,13 +56,51 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
</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">- // Send the message
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the email address for who is getting the friend request.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $to Email address for who is getting the friend request.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $to = apply_filters( 'friends_notification_new_request_to', $to );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the subject for the friend request email.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $subject Subject line to be used in friend request email.
+ * @param string $initiator_name Name of the person requesting friendship.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $subject = apply_filters( 'friends_notification_new_request_subject', $subject, $initiator_name );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the message for the friend request email.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $message Message to be used in friend request email.
+ * @param string $initiator_name Name of the person requesting friendship.
+ * @param string $initiator_link Profile link of person requesting friendship.
+ * @param string $all_requests_link User's friends request management link.
+ * @param string $settings_link Email recipient's settings management link.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $message = apply_filters( 'friends_notification_new_request_message', $message, $initiator_name, $initiator_link, $all_requests_link, $settings_link );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_mail( $to, $subject, $message );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the new friend request email is sent.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param int $friend_id ID of the request recipient.
+ * @param string $subject Text for the friend request subject field.
+ * @param string $message Text for the friend request message field.
+ * @param int $friendship_id ID of the friendship object.
+ * @param int $initiator_id ID of the friendship requester.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_friends_sent_request_email', $friend_id, $subject, $message, $friendship_id, $initiator_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_requested', 'friends_notification_new_request', 10, 3 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -105,13 +143,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
</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">- // Send the message
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the email address for whose friend request got accepted.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $to Email address for whose friend request got accepted.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $to = apply_filters( 'friends_notification_accepted_request_to', $to );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the subject for the friend request accepted email.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $subject Subject line to be used in friend request accepted email.
+ * @param string $friend_name Name of the person who accepted the friendship request.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $subject = apply_filters( 'friends_notification_accepted_request_subject', $subject, $friend_name );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the message for the friend request accepted email.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $message Message to be used in friend request email.
+ * @param string $friend_name Name of the person who accepted the friendship request.
+ * @param string $friend_link Profile link of person who accepted the friendship request.
+ * @param string $settings_link Email recipient's settings management link.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $message = apply_filters( 'friends_notification_accepted_request_message', $message, $friend_name, $friend_link, $settings_link );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_mail( $to, $subject, $message );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the friend request accepted email is sent.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param int $initiator_id ID of the friendship requester.
+ * @param string $subject Text for the friend request subject field.
+ * @param string $message Text for the friend request message field.
+ * @param int $friendship_id ID of the friendship object.
+ * @param int $friend_id ID of the request recipient.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_friends_sent_accepted_email', $initiator_id, $subject, $message, $friendship_id, $friend_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_accepted', 'friends_notification_accepted_request', 10, 3 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,14 +244,46 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Return either an HTML link or an array, depending on the requested format
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'string' == $format ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the format of friendship notifications based on type and amount * of notifications pending.
+ *
+ * This is a variable filter that has four possible versions.
+ * The four possible versions are:
+ * - bp_friends_single_friendship_accepted_notification
+ * - bp_friends_multiple_friendship_accepted_notification
+ * - bp_friends_single_friendship_request_notification
+ * - bp_friends_multiple_friendship_request_notification
+ *
+ * @since BuddyPress (1.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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $return = apply_filters( 'bp_friends_' . $amount . '_friendship_' . $action . '_notification', '<a href="' . esc_url( $link ) . '">' . esc_html( $text ) . '</a>', (int) $total_items, $item_id );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in bp-friends/bp-friends-notifications.php */
</ins><span class="cx" style="display: block; padding: 0 10px"> $return = apply_filters( 'bp_friends_' . $amount . '_friendship_' . $action . '_notification', array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'link' => $link,
</span><span class="cx" style="display: block; padding: 0 10px"> 'text' => $text
</span><span class="cx" style="display: block; padding: 0 10px"> ), (int) $total_items, $item_id );
</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">+ /**
+ * Fires at the end of the bp-friends notification format callback.
+ *
+ * @since BuddyPress (1.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 messaging-related notifications
+ * waiting for the user.
+ * @param array|string $return Notification text string or array of link and text.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'friends_format_notifications', $action, $item_id, $secondary_item_id, $total_items, $return );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $return;
</span></span></pre>
</div>
</div>
</body>
</html>