<!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][8126] trunk: Use WP Plugin API rather than call_user_func() to apply format_callback to activity actions</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/8126">8126</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-13 19:05:27 +0000 (Thu, 13 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Use WP Plugin API rather than call_user_func() to apply format_callback to activity actions
This allows plugin authors to modify or override default formatting callbacks
using the standard remove_filter() and add_filter() API functions.
Hat-tip to nacin for the idea
See <a href="http://buddypress.trac.wordpress.org/ticket/3856">#3856</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityfunctionsphp">trunk/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunkbpblogsbpblogsactivityphp">trunk/bp-blogs/bp-blogs-activity.php</a></li>
<li><a href="#trunkbpfriendsbpfriendsactivityphp">trunk/bp-friends/bp-friends-activity.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsactivityphp">trunk/bp-groups/bp-groups-activity.php</a></li>
<li><a href="#trunkbpxprofilebpxprofileactivityphp">trunk/bp-xprofile/bp-xprofile-activity.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-functions.php (8125 => 8126)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-functions.php 2014-03-13 18:34:06 UTC (rev 8125)
+++ trunk/bp-activity/bp-activity-functions.php 2014-03-13 19:05:27 UTC (rev 8126)
</span><span class="lines">@@ -912,7 +912,16 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return call_user_func( buddypress()->activity->actions->{$activity->component}->{$activity->type}['format_callback'], $activity );
</del><ins>+ // We apply the format_callback as a filter
+ add_filter( 'bp_activity_generate_action_string', buddypress()->activity->actions->{$activity->component}->{$activity->type}['format_callback'], 10, 2 );
+
+ // Generate the action string (run through the filter defined above)
+ $action = apply_filters( 'bp_activity_generate_action_string', $activity->action, $activity );
+
+ // Remove the filter for future activity items
+ remove_filter( 'bp_activity_generate_action_string', buddypress()->activity->actions->{$activity->component}->{$activity->type}['format_callback'], 10, 2 );
+
+ return $action;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -920,10 +929,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity data object.
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>-function bp_activity_format_activity_action_activity_update( $activity ) {
</del><ins>+function bp_activity_format_activity_action_activity_update( $action, $activity ) {
</ins><span class="cx"> $action = sprintf( __( '%s posted an update', 'buddypress' ), bp_core_get_userlink( $activity->user_id ) );
</span><span class="cx"> return apply_filters( 'bp_activity_new_update_action', $action, $activity );
</span><span class="cx"> }
</span><span class="lines">@@ -933,10 +943,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity data object.
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>-function bp_activity_format_activity_action_activity_comment( $activity ) {
</del><ins>+function bp_activity_format_activity_action_activity_comment( $action, $activity ) {
</ins><span class="cx"> $action = sprintf( __( '%s posted a new activity comment', 'buddypress' ), bp_core_get_userlink( $activity->user_id ) );
</span><span class="cx"> return apply_filters( 'bp_activity_comment_action', $action, $activity );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkbpblogsbpblogsactivityphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-blogs/bp-blogs-activity.php (8125 => 8126)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-blogs/bp-blogs-activity.php 2014-03-13 18:34:06 UTC (rev 8125)
+++ trunk/bp-blogs/bp-blogs-activity.php 2014-03-13 19:05:27 UTC (rev 8126)
</span><span class="lines">@@ -59,9 +59,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param obj $activity Activity data object.
</span><span class="cx"> */
</span><del>-function bp_blogs_format_activity_action_new_blog( $activity ) {
</del><ins>+function bp_blogs_format_activity_action_new_blog( $action, $activity ) {
</ins><span class="cx"> $blog_url = bp_blogs_get_blogmeta( $activity->item_id, 'url' );
</span><span class="cx"> $blog_name = bp_blogs_get_blogmeta( $activity->item_id, 'name' );
</span><span class="cx">
</span><span class="lines">@@ -87,9 +88,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param obj $activity Activity data object.
</span><span class="cx"> */
</span><del>-function bp_blogs_format_activity_action_new_blog_post( $activity ) {
</del><ins>+function bp_blogs_format_activity_action_new_blog_post( $action, $activity ) {
</ins><span class="cx"> $blog_url = bp_blogs_get_blogmeta( $activity->item_id, 'url' );
</span><span class="cx"> $blog_name = bp_blogs_get_blogmeta( $activity->item_id, 'name' );
</span><span class="cx">
</span><span class="lines">@@ -147,9 +149,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param obj $activity Activity data object.
</span><span class="cx"> */
</span><del>-function bp_blogs_format_activity_action_new_blog_comment( $activity ) {
</del><ins>+function bp_blogs_format_activity_action_new_blog_comment( $action, $activity ) {
</ins><span class="cx"> $blog_url = bp_blogs_get_blogmeta( $activity->item_id, 'url' );
</span><span class="cx"> $blog_name = bp_blogs_get_blogmeta( $activity->item_id, 'name' );
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpfriendsbpfriendsactivityphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-friends/bp-friends-activity.php (8125 => 8126)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-friends/bp-friends-activity.php 2014-03-13 18:34:06 UTC (rev 8125)
+++ trunk/bp-friends/bp-friends-activity.php 2014-03-13 19:05:27 UTC (rev 8126)
</span><span class="lines">@@ -121,7 +121,7 @@
</span><span class="cx"> * @param object $activity Activity data.
</span><span class="cx"> * @return string $action Formatted activity action.
</span><span class="cx"> */
</span><del>-function bp_friends_format_activity_action_friendship_accepted( $activity ) {
</del><ins>+function bp_friends_format_activity_action_friendship_accepted( $action, $activity ) {
</ins><span class="cx"> $initiator_link = bp_core_get_userlink( $activity->user_id );
</span><span class="cx"> $friend_link = bp_core_get_userlink( $activity->secondary_item_id );
</span><span class="cx">
</span><span class="lines">@@ -143,10 +143,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity data.
</span><span class="cx"> * @return string $action Formatted activity action.
</span><span class="cx"> */
</span><del>-function bp_friends_format_activity_action_friendship_created( $activity ) {
</del><ins>+function bp_friends_format_activity_action_friendship_created( $action, $activity ) {
</ins><span class="cx"> $initiator_link = bp_core_get_userlink( $activity->user_id );
</span><span class="cx"> $friend_link = bp_core_get_userlink( $activity->secondary_item_id );
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsactivityphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-activity.php (8125 => 8126)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-activity.php 2014-03-13 18:34:06 UTC (rev 8125)
+++ trunk/bp-groups/bp-groups-activity.php 2014-03-13 19:05:27 UTC (rev 8126)
</span><span class="lines">@@ -54,10 +54,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity data object.
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>-function bp_groups_format_activity_action_created_group( $activity ) {
</del><ins>+function bp_groups_format_activity_action_created_group( $action, $activity ) {
</ins><span class="cx"> $user_link = bp_core_get_userlink( $activity->user_id );
</span><span class="cx">
</span><span class="cx"> $group = groups_get_group( array(
</span><span class="lines">@@ -76,10 +77,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity data object.
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>-function bp_groups_format_activity_action_joined_group( $activity ) {
</del><ins>+function bp_groups_format_activity_action_joined_group( $action, $activity ) {
</ins><span class="cx"> $user_link = bp_core_get_userlink( $activity->user_id );
</span><span class="cx">
</span><span class="cx"> $group = groups_get_group( array(
</span></span></pre></div>
<a id="trunkbpxprofilebpxprofileactivityphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-xprofile/bp-xprofile-activity.php (8125 => 8126)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-activity.php 2014-03-13 18:34:06 UTC (rev 8125)
+++ trunk/bp-xprofile/bp-xprofile-activity.php 2014-03-13 19:05:27 UTC (rev 8126)
</span><span class="lines">@@ -47,10 +47,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity object.
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>-function bp_xprofile_format_activity_action_new_avatar( $activity ) {
</del><ins>+function bp_xprofile_format_activity_action_new_avatar( $action, $activity ) {
</ins><span class="cx"> $userlink = bp_core_get_userlink( $activity->user_id );
</span><span class="cx"> $action = sprintf( __( '%s changed their profile picture', 'buddypress' ), $userlink );
</span><span class="cx">
</span><span class="lines">@@ -67,10 +68,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity object.
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>-function bp_xprofile_format_activity_action_new_member( $activity ) {
</del><ins>+function bp_xprofile_format_activity_action_new_member( $action, $activity ) {
</ins><span class="cx"> $userlink = bp_core_get_userlink( $activity->user_id );
</span><span class="cx"> $action = sprintf( __( '%s became a registered member', 'buddypress' ), $userlink );
</span><span class="cx">
</span><span class="lines">@@ -87,10 +89,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span><span class="cx"> *
</span><ins>+ * @param string $action Static activity action.
</ins><span class="cx"> * @param object $activity Activity object.
</span><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>-function bp_xprofile_format_activity_action_updated_profile( $activity ) {
</del><ins>+function bp_xprofile_format_activity_action_updated_profile( $action, $activity ) {
</ins><span class="cx"> // Note for translators: The natural phrasing in English, "Joe updated
</span><span class="cx"> // his profile", requires that we know Joe's gender, which we don't. If
</span><span class="cx"> // your language doesn't have this restriction, feel free to use a more
</span></span></pre>
</div>
</div>
</body>
</html>