<!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][10284] trunk/src: Allow plugins to format xprofile-related 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 { 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/10284">10284</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/10284","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>2015-10-17 15:58:30 +0000 (Sat, 17 Oct 2015)</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'>Allow plugins to format xprofile-related notifications.
Adds a hook so that plugins may generate
xprofile-related notifications (with the
`component_name` of `xprofile`) and
format those notification using a
dynamic filter based on the name
of the `component_action`.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6663">#6663</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpnotificationsbpnotificationsfunctionsphp">trunk/src/bp-notifications/bp-notifications-functions.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofileloaderphp">trunk/src/bp-xprofile/bp-xprofile-loader.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofilenotificationsphp">trunk/src/bp-xprofile/bp-xprofile-notifications.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpnotificationsbpnotificationsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/bp-notifications-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/bp-notifications-functions.php 2015-10-17 14:31:48 UTC (rev 10283)
+++ trunk/src/bp-notifications/bp-notifications-functions.php 2015-10-17 15:58:30 UTC (rev 10284)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,6 +200,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Calculate a renderable output for each notification type
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $grouped_notifications as $component_name => $action_arrays ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We prefer that extended profile component-related notifications use
+ // the component_name of 'xprofile'. However, the extended profile child
+ // object in the $bp object is keyed as 'profile', which is where we need
+ // to look for the registered notification callback.
+ if ( 'xprofile' == $component_name ) {
+ $component_name = 'profile';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Skip if group is empty
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $action_arrays ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -611,6 +619,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $bp->$component->notification_callback ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $component_names[] = $component;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The extended profile component is identified in the active_components array as 'xprofile'.
+ // However, the extended profile child object has the key 'profile' in the $bp object.
+ if ( 'xprofile' == $component && ! empty( $bp->profile->notification_callback ) ) {
+ $component_names[] = $component;
+ }
</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="trunksrcbpxprofilebpxprofileloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-loader.php 2015-10-17 14:31:48 UTC (rev 10283)
+++ trunk/src/bp-xprofile/bp-xprofile-loader.php 2015-10-17 15:58:30 UTC (rev 10284)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,6 +67,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'settings',
</span><span class="cx" style="display: block; padding: 0 10px"> 'template',
</span><span class="cx" style="display: block; padding: 0 10px"> 'functions',
</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 ( is_admin() ) {
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilenotificationsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/bp-xprofile/bp-xprofile-notifications.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-notifications.php (rev 0)
+++ trunk/src/bp-xprofile/bp-xprofile-notifications.php 2015-10-17 15:58:30 UTC (rev 10284)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,49 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/** Notifications *************************************************************/
+
+/**
+ * Format notifications for the extended profile (Xprofile) component.
+ *
+ * @since 2.4.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 string $format 'string' for BuddyBar-compatible notifications; 'array'
+ * for WP Toolbar. Default: 'string'.
+ *
+ * @return string
+ */
+function xprofile_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
+ switch ( $action ) {
+ default:
+
+ /**
+ * Allows plugins to filter extended profile-related custom notifications.
+ * Notifications must have a 'component_name' of 'xprofile' to be routed
+ * to this function.
+ *
+ *
+ * @since 2.4.0
+ *
+ * @param string $notification Null value.
+ * @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 string $format 'string' for BuddyBar-compatible notifications;
+ * 'array' for WP Toolbar.
+ */
+ $custom_action_notification = apply_filters( 'bp_xprofile_' . $action . '_notification', null, $item_id, $secondary_item_id, $total_items, $format );
+
+ if ( ! is_null( $custom_action_notification ) ) {
+ return $custom_action_notification;
+ }
+
+ break;
+ }
+
+ return false;
+}
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>