<!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][10706] trunk/src/bp-messages/bp-messages-notifications.php: Messages: Introduce dynamic filter, `"bp_messages_{$action}_notification"`.</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/10706">10706</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/10706","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>2016-04-14 20:36:39 +0000 (Thu, 14 Apr 2016)</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'>Messages: Introduce dynamic filter, `"bp_messages_{$action}_notification"`.
This new filter helps plugin developers filter private message
notifications that are not the `'new_message'` action.
For backward compatibility, we apply the existing
`"bp_messages_{$amount}_new_message_notification"` filter just before
adding our new dynamic filter.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6750">#6750</a>.
Props imath.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagesnotificationsphp">trunk/src/bp-messages/bp-messages-notifications.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagesnotificationsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-notifications.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-notifications.php 2016-04-13 23:38:53 UTC (rev 10705)
+++ trunk/src/bp-messages/bp-messages-notifications.php 2016-04-14 20:36:39 UTC (rev 10706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,6 +103,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $total_items = (int) $total_items;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $text = '';
</ins><span class="cx" style="display: block; padding: 0 10px"> $link = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/inbox' );
</span><span class="cx" style="display: block; padding: 0 10px"> $title = __( 'Inbox', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px"> $amount = 'single';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -111,9 +112,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $total_items > 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $amount = 'multiple';
</span><span class="cx" style="display: block; padding: 0 10px"> $text = sprintf( __( 'You have %d new messages', 'buddypress' ), $total_items );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $amount = 'single';
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Get message thread ID.
</span><span class="cx" style="display: block; padding: 0 10px"> $message = new BP_Messages_Message( $item_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $thread_id = $message->thread_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,35 +127,78 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $text = sprintf( _n( 'You have %s new private message', 'You have %s new private messages', $total_items, 'buddypress' ), bp_core_number_format( $total_items ) );
</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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'string' === $format ) {
- if ( ! empty( $link ) ) {
- $retval = '<a href="' . esc_url( $link ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $text ) . '</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'string' === $format ) {
+ if ( ! empty( $link ) ) {
+ $return = '<a href="' . esc_url( $link ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $text ) . '</a>';
+ } else {
+ $return = esc_html( $text );
+ }
+
+ /**
+ * Filters the new message notification text before the notification is created.
+ *
+ * This is a dynamic filter. Possible filter names are:
+ * - 'bp_messages_multiple_new_message_notification'.
+ * - 'bp_messages_single_new_message_notification'.
+ *
+ * @param string $return Notification text.
+ * @param int $total_items Number of messages referred to by the notification.
+ * @param string $text The raw notification test (ie, not wrapped in a link).
+ * @param int $item_id ID of the associated item.
+ * @param int $secondary_item_id ID of the secondary associated item.
+ */
+ $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', $return, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $retval = esc_html( $text );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in bp-messages/bp-messages-notifications.php */
+ $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', array(
+ 'text' => $text,
+ 'link' => $link
+ ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
</ins><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">+ // Custom notification action for the Messages component
+ } else {
+ if ( 'string' === $format ) {
+ $return = $text;
+ } else {
+ $return = array(
+ 'text' => $text,
+ 'link' => $link
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the new message notification text before the notification is created.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Backcompat for plugins that used to filter bp_messages_single_new_message_notification
+ * for their custom actions. These plugins should now use 'bp_messages_' . $action . '_notification'
+ */
+ if ( has_filter( 'bp_messages_single_new_message_notification' ) ) {
+ if ( 'string' === $format ) {
+ /** This filter is documented in bp-messages/bp-messages-notifications.php */
+ $return = apply_filters( 'bp_messages_single_new_message_notification', $return, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+
+ // Notice that there are seven parameters instead of six? Ugh...
+ } else {
+ /** This filter is documented in bp-messages/bp-messages-notifications.php */
+ $return = apply_filters( 'bp_messages_single_new_message_notification', $return, $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+ }
+ }
+
+ /**
+ * Filters the custom action notification before the notification is created.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This is a dynamic filter. Possible filter names are:
- * - 'bp_messages_multiple_new_message_notification'.
- * - 'bp_messages_single_new_message_notification'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This is a dynamic filter based on the message notification action.
</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 $retval Notification text.
- * @param int $total_items Number of messages referred to by the notification.
- * @param string $text The raw notification test (ie, not wrapped in a link).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.6.0
+ *
+ * @param array $value An associative array containing the text and the link of the notification
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $item_id ID of the associated item.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $secondary_item_id ID of the secondary associated item.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $total_items Number of messages referred to by the notification.
+ * @param string $format Return value format. 'string' for BuddyBar-compatible
+ * notifications; 'array' for WP Toolbar. Default: 'string'.
</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 = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', $retval, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
- } else {
- /** This filter is documented in bp-messages/bp-messages-notifications.php */
- $return = apply_filters( 'bp_messages_' . $amount . '_new_message_notification', array(
- 'text' => $text,
- 'link' => $link
- ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $return = apply_filters( "bp_messages_{$action}_notification", $return, $item_id, $secondary_item_id, $total_items, $format );
</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>
</div>
</body>
</html>