<!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][7578] trunk/bp-notifications: Allow non-core components to hook into notifications via a filter.</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7578">7578</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2013-11-16 01:08:49 +0000 (Sat, 16 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Allow non-core components to hook into notifications via a filter. This allows components that are not registered as part of the main BuddyPress singleton to hook a callback into a filter instead. See <a href="http://buddypress.trac.wordpress.org/ticket/5148">#5148</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpnotificationsbpnotificationsfunctionsphp">trunk/bp-notifications/bp-notifications-functions.php</a></li>
<li><a href="#trunkbpnotificationsbpnotificationstemplatephp">trunk/bp-notifications/bp-notifications-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpnotificationsbpnotificationsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-functions.php (7577 => 7578)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-functions.php 2013-11-15 21:31:46 UTC (rev 7577)
+++ trunk/bp-notifications/bp-notifications-functions.php 2013-11-16 01:08:49 UTC (rev 7578)
</span><span class="lines">@@ -147,11 +147,6 @@
</span><span class="cx"> continue;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Skip inactive components
- if ( ! bp_is_active( $component_name ) ) {
- continue;
- }
-
</del><span class="cx"> // Loop through each actionable item and try to map it to a component
</span><span class="cx"> foreach ( (array) $action_arrays as $component_action_name => $component_action_items ) {
</span><span class="cx">
</span><span class="lines">@@ -167,7 +162,7 @@
</span><span class="cx"> if ( isset( $bp->{$component_name}->notification_callback ) && is_callable( $bp->{$component_name}->notification_callback ) ) {
</span><span class="cx">
</span><span class="cx"> // Function should return an object
</span><del>- if ( 'object' == $format ) {
</del><ins>+ if ( 'object' === $format ) {
</ins><span class="cx">
</span><span class="cx"> // Retrieve the content of the notification using the callback
</span><span class="cx"> $content = call_user_func(
</span><span class="lines">@@ -204,6 +199,45 @@
</span><span class="cx"> // @deprecated format_notification_function - 1.5
</span><span class="cx"> } elseif ( isset( $bp->{$component_name}->format_notification_function ) && function_exists( $bp->{$component_name}->format_notification_function ) ) {
</span><span class="cx"> $renderable[] = call_user_func( $bp->{$component_name}->format_notification_function, $component_action_name, $component_action_items[0]->item_id, $component_action_items[0]->secondary_item_id, $action_item_count );
</span><ins>+
+ // Allow non BuddyPress components to hook in
+ } else {
+
+ // The array to reference with apply_filters_ref_array()
+ $ref_array = array(
+ $component_action_name,
+ $component_action_items[0]->item_id,
+ $component_action_items[0]->secondary_item_id,
+ $action_item_count,
+ $format
+ );
+
+ // Function should return an object
+ if ( 'object' === $format ) {
+
+ // Retrieve the content of the notification using the callback
+ $content = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', $ref_array );
+
+ // Create the object to be returned
+ $notification_object = new stdClass;
+
+ // Minimal backpat with non-compatible notification
+ // callback functions
+ if ( is_string( $content ) ) {
+ $notification_object->content = $content;
+ $notification_object->href = bp_loggedin_user_domain();
+ } else {
+ $notification_object->content = $content['text'];
+ $notification_object->href = $content['link'];
+ }
+
+ $notification_object->id = $component_action_items[0]->id;
+ $renderable[] = $notification_object;
+
+ // Return an array of content strings
+ } else {
+ $renderable[] = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', $ref_array );
+ }
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkbpnotificationsbpnotificationstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-template.php (7577 => 7578)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-template.php 2013-11-15 21:31:46 UTC (rev 7577)
+++ trunk/bp-notifications/bp-notifications-template.php 2013-11-16 01:08:49 UTC (rev 7578)
</span><span class="lines">@@ -690,11 +690,6 @@
</span><span class="cx"> $bp = buddypress();
</span><span class="cx"> $notification = $bp->notifications->query_loop->notification;
</span><span class="cx">
</span><del>- // Skip inactive components
- if ( ! bp_is_active( $notification->component_name ) ) {
- return;
- }
-
</del><span class="cx"> // Callback function exists
</span><span class="cx"> if ( isset( $bp->{ $notification->component_name }->notification_callback ) && is_callable( $bp->{ $notification->component_name }->notification_callback ) ) {
</span><span class="cx"> $description = call_user_func( $bp->{ $notification->component_name }->notification_callback, $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1 );
</span><span class="lines">@@ -702,6 +697,10 @@
</span><span class="cx"> // @deprecated format_notification_function - 1.5
</span><span class="cx"> } elseif ( isset( $bp->{ $notification->component_name }->format_notification_function ) && function_exists( $bp->{ $notification->component_name }->format_notification_function ) ) {
</span><span class="cx"> $description = call_user_func( $bp->{ $notification->component_name }->format_notification_function, $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1 );
</span><ins>+
+ // Allow non BuddyPress components to hook in
+ } else {
+ $description = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', array( $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1 ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Filter and return
</span></span></pre>
</div>
</div>
</body>
</html>