<!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][7397] trunk/bp-activity/bp-activity-filters.php: Inline doc improvements in 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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7397">7397</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-08 20:57:54 +0000 (Tue, 08 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline doc improvements in bp-activity-filters.php
See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityfiltersphp">trunk/bp-activity/bp-activity-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityfiltersphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-filters.php (7396 => 7397)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-filters.php 2013-10-08 20:57:45 UTC (rev 7396)
+++ trunk/bp-activity/bp-activity-filters.php 2013-10-08 20:57:54 UTC (rev 7397)
</span><span class="lines">@@ -1,7 +1,7 @@
</span><span class="cx"> <?php
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * The Activity filters
</del><ins>+ * Filters related to the Activity component.
</ins><span class="cx"> *
</span><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @subpackage ActivityFilters
</span><span class="lines">@@ -78,7 +78,7 @@
</span><span class="cx">
</span><span class="cx"> add_filter( 'bp_activity_primary_link_before_save', 'esc_url_raw' );
</span><span class="cx">
</span><del>-// Apply BuddyPress defined filters
</del><ins>+// Apply BuddyPress-defined filters
</ins><span class="cx"> add_filter( 'bp_get_activity_content', 'bp_activity_make_nofollow_filter' );
</span><span class="cx"> add_filter( 'bp_get_activity_content_body', 'bp_activity_make_nofollow_filter' );
</span><span class="cx"> add_filter( 'bp_get_activity_parent_content', 'bp_activity_make_nofollow_filter' );
</span><span class="lines">@@ -108,9 +108,11 @@
</span><span class="cx"> /** Functions *****************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Types of activity stream items to check against
</del><ins>+ * Types of activity stream items to moderate.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @return array $types List of the activity types to moderate.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_get_moderated_activity_types() {
</span><span class="cx"> $types = array(
</span><span class="lines">@@ -121,10 +123,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check activity stream for moderation keys
</del><ins>+ * Moderate the posted activity item, if it contains moderate keywords.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><del>- * @param BP_Activity_Activity $activity
</del><ins>+ *
+ * @param BP_Activity_Activity $activity The activity object to check.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_check_moderation_keys( $activity ) {
</span><span class="cx">
</span><span class="lines">@@ -139,10 +142,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check activity stream for blacklisted keys
</del><ins>+ * Mark the posted activity as spam, if it contains blacklist keywords.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><del>- * @param BP_Activity_Activity $activity
</del><ins>+ *
+ * @param BP_Activity_Activity $activity The activity object to check.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_check_blacklist_keys( $activity ) {
</span><span class="cx">
</span><span class="lines">@@ -156,16 +160,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Custom kses filtering for activity content
</del><ins>+ * Custom kses filtering for activity content.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.1)
</span><span class="cx"> *
</span><del>- * @param string $content The activity content
- *
</del><span class="cx"> * @uses apply_filters() To call the 'bp_activity_allowed_tags' hook.
</span><span class="cx"> * @uses wp_kses()
</span><span class="cx"> *
</span><del>- * @return string $content Filtered activity content
</del><ins>+ * @param string $content The activity content.
+ * @return string $content Filtered activity content.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_filter_kses( $content ) {
</span><span class="cx"> global $allowedtags;
</span><span class="lines">@@ -196,13 +199,12 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><del>- * @param string $content The contents of a given item.
- * @param int $activity_id The activity id. Deprecated.
- *
</del><span class="cx"> * @uses bp_activity_find_mentions()
</span><span class="cx"> * @uses bp_core_get_user_domain()
</span><span class="cx"> *
</span><del>- * @return string $content Content filtered for mentions
</del><ins>+ * @param string $content The contents of a given item.
+ * @param int $activity_id The activity id. Deprecated.
+ * @return string $content Content filtered for mentions.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_at_name_filter( $content, $activity_id = 0 ) {
</span><span class="cx">
</span><span class="lines">@@ -228,16 +230,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Catch mentions in activity items before they are saved into the database.
</del><ins>+ * Catch mentions in an activity item before it is saved into the database.
</ins><span class="cx"> *
</span><span class="cx"> * If mentions are found, replace @mention text with user links and add our
</span><del>- * hook to send mentions after the activity item is saved.
</del><ins>+ * hook to send mention notifications after the activity item is saved.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><ins>+ * @uses bp_activity_find_mentions()
+ *
</ins><span class="cx"> * @param BP_Activity_Activity $activity
</span><del>- *
- * @uses bp_activity_find_mentions()
</del><span class="cx"> */
</span><span class="cx"> function bp_activity_at_name_filter_updates( $activity ) {
</span><span class="cx"> // Are mentions disabled?
</span><span class="lines">@@ -268,15 +270,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sends emails and BP notifications for @-mentioned users in the contents of
- * an activity item.
</del><ins>+ * Sends emails and BP notifications for users @-mentioned in an activity item.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> *
</span><del>- * @param BP_Activity_Activity $activity The BP_Activity_Activity object
- *
</del><span class="cx"> * @uses bp_activity_at_message_notification()
</span><span class="cx"> * @uses bp_activity_update_mention_count_for_user()
</span><ins>+ *
+ * @param BP_Activity_Activity $activity The BP_Activity_Activity object
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_at_name_send_emails( $activity ) {
</span><span class="cx"> // Are mentions disabled?
</span><span class="lines">@@ -307,25 +308,25 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Catches links in activity text so rel=nofollow can be added
</del><ins>+ * Catch links in activity text so rel=nofollow can be added.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><del>- * @param string $text Activity text
- *
- * @return string $text Text with rel=nofollow added to any links
</del><ins>+ * @param string $text Activity text.
+ * @return string $text Text with rel=nofollow added to any links.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_make_nofollow_filter( $text ) {
</span><span class="cx"> return preg_replace_callback( '|<a (.+?)>|i', 'bp_activity_make_nofollow_filter_callback', $text );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Adds rel=nofollow to a link
</del><ins>+ * Add rel=nofollow to a link.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="cx"> * @param array $matches
</span><span class="cx"> *
</span><ins>+ * @param array $matches Items matched by preg_replace_callback() in bp_activity_make_nofollow_filter().
</ins><span class="cx"> * @return string $text Link with rel=nofollow added
</span><span class="cx"> */
</span><span class="cx"> function bp_activity_make_nofollow_filter_callback( $matches ) {
</span><span class="lines">@@ -335,21 +336,20 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Truncates long activity entries when viewed in activity streams
</del><ins>+ * Truncate long activity entries when viewed in activity streams.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><del>- * @param string $text The original activity entry text
- *
</del><span class="cx"> * @uses bp_is_single_activity()
</span><del>- * @uses apply_filters() To call the 'bp_activity_excerpt_append_text' hook
- * @uses apply_filters() To call the 'bp_activity_excerpt_length' hook
</del><ins>+ * @uses apply_filters() To call the 'bp_activity_excerpt_append_text' hook.
+ * @uses apply_filters() To call the 'bp_activity_excerpt_length' hook.
</ins><span class="cx"> * @uses bp_create_excerpt()
</span><span class="cx"> * @uses bp_get_activity_id()
</span><span class="cx"> * @uses bp_get_activity_thread_permalink()
</span><del>- * @uses apply_filters() To call the 'bp_activity_truncate_entry' hook
</del><ins>+ * @uses apply_filters() To call the 'bp_activity_truncate_entry' hook.
</ins><span class="cx"> *
</span><del>- * @return string $excerpt The truncated text
</del><ins>+ * @param string $text The original activity entry text.
+ * @return string $excerpt The truncated text.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_truncate_entry( $text ) {
</span><span class="cx"> global $activities_template;
</span></span></pre>
</div>
</div>
</body>
</html>