<!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][9111] trunk/src/bp-activity/bp-activity-filters.php: Hook documentation for bp-activity-filters.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/9111">9111</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/9111","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-10-30 23:56:28 +0000 (Thu, 30 Oct 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'>Hook documentation for bp-activity-filters.php.
Props tw2113.
See <a href="http://buddypress.trac.wordpress.org/ticket/5938">#5938</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivityfiltersphp">trunk/src/bp-activity/bp-activity-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivityfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-filters.php 2014-10-30 23:55:04 UTC (rev 9110)
+++ trunk/src/bp-activity/bp-activity-filters.php 2014-10-30 23:56:28 UTC (rev 9111)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,7 +113,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Types of activity stream items to moderate.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.6)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.6.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array $types List of the activity types to moderate.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -122,13 +122,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'activity_comment',
</span><span class="cx" style="display: block; padding: 0 10px"> 'activity_update'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the default activity types that BuddyPress should moderate.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array $types Default activity types to moderate.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_activity_check_activity_types', $types );
</span><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 class="cx" style="display: block; padding: 0 10px"> * Moderate the posted activity item, if it contains moderate keywords.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.6)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.6.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param BP_Activity_Activity $activity The activity object to check.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -147,7 +155,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Mark the posted activity as spam, if it contains blacklist keywords.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.6)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.6.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param BP_Activity_Activity $activity The activity object to check.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,7 +173,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Custom kses filtering for activity content.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.1)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.1.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses apply_filters() To call the 'bp_activity_allowed_tags' hook.
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses wp_kses()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,6 +204,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_allowedtags['span']['class'] = array();
</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">+ /**
+ * Filters the allowed HTML tags for BuddyPress Activity content.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param array Array of allowed HTML tags and attributes.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $activity_allowedtags = apply_filters( 'bp_activity_allowed_tags', $activity_allowedtags );
</span><span class="cx" style="display: block; padding: 0 10px"> return wp_kses( $content, $activity_allowedtags );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,7 +276,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If mentions are found, replace @mention text with user links and add our
</span><span class="cx" style="display: block; padding: 0 10px"> * hook to send mention notifications after the activity item is saved.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.5)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.5.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_activity_find_mentions()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -298,7 +313,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Sends emails and BP notifications for users @-mentioned in an activity item.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_activity_at_message_notification()
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_activity_update_mention_count_for_user()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -323,7 +338,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Send @mentions and setup BP notifications
</span><span class="cx" style="display: block; padding: 0 10px"> foreach( (array) $usernames as $user_id => $username ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If you want to disable notifications, you can use this filter to stop email sending
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters BuddyPress' ability to send email notifications for @mentions.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param bool Whether or not BuddyPress should send a notification to the mentioned users.
+ * @param array $usernames Array of users potentially notified.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( apply_filters( 'bp_activity_at_name_do_notifications', true, $usernames ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_activity_at_message_notification( $activity->id, $user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -336,7 +358,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Catch links in activity text so rel=nofollow can be added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.2)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.2.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Activity text.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string $text Text with rel=nofollow added to any links.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -348,7 +370,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Add rel=nofollow to a link.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.2)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.2.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $matches
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -364,7 +386,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Truncate long activity entries when viewed in activity streams.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.5)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.5.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_is_single_activity()
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses apply_filters() To call the 'bp_activity_excerpt_append_text' hook.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -384,7 +406,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_single_activity() )
</span><span class="cx" style="display: block; padding: 0 10px"> return $text;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the appended text for the activity excerpt.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $read_more Internationalized "Read more" text.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $append_text = apply_filters( 'bp_activity_excerpt_append_text', __( '[Read more]', 'buddypress' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the excerpt length for the activity excerpt.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param int $excerpt_length Number indicating how many words to trim the excerpt down to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $excerpt_length = apply_filters( 'bp_activity_excerpt_length', 358 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Run the text through the excerpt function. If it's too short, the original text will be
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -400,6 +437,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $excerpt = sprintf( '%1$s<span class="activity-read-more" id="%2$s"><a href="%3$s" rel="nofollow">%4$s</a></span>', $excerpt, $id, bp_get_activity_thread_permalink(), $append_text );
</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">+ /**
+ * Filters the composite activity excerpt entry.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $excerpt Excerpt text and markup to be displayed.
+ * @param string $text The original activity entry text.
+ * @param string $append_text The final append text applied.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_activity_truncate_entry', $excerpt, $text, $append_text );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -552,14 +598,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $global_pulse = 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Check whether the global heartbeat settings already exist.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filter that checks whether the global heartbeat settings already exist.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $settings Heartbeat settings array.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $heartbeat_settings = apply_filters( 'heartbeat_settings', array() );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $heartbeat_settings['interval'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // 'Fast' is 5
</span><span class="cx" style="display: block; padding: 0 10px"> $global_pulse = is_numeric( $heartbeat_settings['interval'] ) ? absint( $heartbeat_settings['interval'] ) : 5;
</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">- // Filter here to specify a BP-specific pulse frequency
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the pulse frequency to be used for the BuddyPress Activity heartbeat.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $frequency The frequency in seconds between pulses.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $bp_activity_pulse = apply_filters( 'bp_activity_heartbeat_pulse', 15 );
</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>