Changeset 10077 for trunk/src/bp-activity/bp-activity-filters.php

Timestamp:

08/31/2015 06:51:35 AM (9 years ago)

Author:

tw2113

Message:

Standardizing our @since tags for the Activity component.

See #6576.

File:

• trunk/src/bp-activity/bp-activity-filters.php (modified) (28 diffs)

trunk/src/bp-activity/bp-activity-filters.php

@@ -1 +1 @@
 <?php
-
 /**
  * Filters related to the Activity component.
@@ -114 +113 @@
  * Types of activity stream items to moderate.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @return array $types List of the activity types to moderate.
@@ -127 +126 @@
      * Filters the default activity types that BuddyPress should moderate.
      *
-     * @since BuddyPress (1.6.0)
+     * @since 1.6.0
      *
      * @param array $types Default activity types to moderate.
@@ -137 +136 @@
  * Moderate the posted activity item, if it contains moderate keywords.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @param BP_Activity_Activity $activity The activity object to check.
@@ -156 +155 @@
  * Mark the posted activity as spam, if it contains blacklist keywords.
  *
- * @since BuddyPress (1.6.0)
+ * @since 1.6.0
  *
  * @param BP_Activity_Activity $activity The activity object to check.
@@ -174 +173 @@
  * Custom kses filtering for activity content.
  *
- * @since BuddyPress (1.1.0)
+ * @since 1.1.0
  *
  * @uses apply_filters() To call the 'bp_activity_allowed_tags' hook.
@@ -209 +208 @@
      * Filters the allowed HTML tags for BuddyPress Activity content.
      *
-     * @since BuddyPress (1.2.0)
+     * @since 1.2.0
      *
      * @param array $value Array of allowed HTML tags and attributes.
@@ -220 +219 @@
  * Find and link @-mentioned users in the contents of a given item.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @param string $content     The contents of a given item.
@@ -279 +278 @@
  * hook to send mention notifications after the activity item is saved.
  *
- * @since BuddyPress (1.5.0)
+ * @since 1.5.0
  *
  * @uses bp_activity_find_mentions()
@@ -316 +315 @@
  * Sends emails and BP notifications for users @-mentioned in an activity item.
  *
- * @since BuddyPress (1.7.0)
+ * @since 1.7.0
  *
  * @uses bp_activity_at_message_notification()
@@ -345 +344 @@
          * Filters BuddyPress' ability to send email notifications for @mentions.
          *
-         * @since BuddyPress (1.6.0)
+         * @since 1.6.0
          *
          * @param bool  $value     Whether or not BuddyPress should send a notification to the mentioned users.
@@ -362 +361 @@
  * Catch links in activity text so rel=nofollow can be added.
  *
- * @since BuddyPress (1.2.0)
+ * @since 1.2.0
  *
  * @param string $text Activity text.
@@ -375 +374 @@
      * Add rel=nofollow to a link.
      *
-     * @since BuddyPress (1.2.0)
+     * @since 1.2.0
      *
      * @param array $matches Items matched by preg_replace_callback() in bp_activity_make_nofollow_filter().
@@ -392 +391 @@
  * This method can only be used inside the Activity loop.
  *
- * @since BuddyPress (1.5.0)
+ * @since 1.5.0
  *
  * @uses bp_is_single_activity()
@@ -412 +411 @@
      * Provides a filter that lets you choose whether to skip this filter on a per-activity basis.
      *
-     * @since BuddyPress (2.3.0)
+     * @since 2.3.0
      *
      * @param bool $value If true, text should be checked to see if it needs truncating.
@@ -429 +428 @@
      * Filters the appended text for the activity excerpt.
      *
-     * @since BuddyPress (1.5.0)
+     * @since 1.5.0
      *
      * @param string $value Internationalized "Read more" text.
@@ -438 +437 @@
      * Filters the excerpt length for the activity excerpt.
      *
-     * @since BuddyPress (1.5.0)
+     * @since 1.5.0
      *
      * @param int $value Number indicating how many words to trim the excerpt down to.
@@ -460 +459 @@
      * Filters the composite activity excerpt entry.
      *
-     * @since BuddyPress (1.5.0)
+     * @since 1.5.0
      *
      * @param string $excerpt     Excerpt text and markup to be displayed.
@@ -472 +471 @@
  * Include extra JavaScript dependencies for activity component.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @uses bp_activity_do_heartbeat() to check if heartbeat is required.
@@ -495 +494 @@
  * dynamically into the activity stream.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @param string $classes
@@ -515 +514 @@
  * Check if Activity Heartbeat feature i on to add a timestamp class.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @param string $classes
@@ -542 +541 @@
  * Use WordPress Heartbeat API to check for latest activity update.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @uses bp_activity_get_last_updated() to get the recorded date of the last activity.
@@ -607 +606 @@
  * Set the strings for WP HeartBeat API where needed.
  *
- * @since BuddyPress (2.0.0)
+ * @since 2.0.0
  *
  * @param array $strings Localized strings.
@@ -624 +623 @@
      * Filter that checks whether the global heartbeat settings already exist.
      *
-     * @since BuddyPress (2.0.0)
+     * @since 2.0.0
      *
      * @param array $value Heartbeat settings array.
@@ -637 +636 @@
      * Filters the pulse frequency to be used for the BuddyPress Activity heartbeat.
      *
-     * @since BuddyPress (2.0.0)
+     * @since 2.0.0
      *
      * @param int $value The frequency in seconds between pulses.
@@ -669 +668 @@
  * Set up activity arguments for use with the 'just-me' scope.
  *
- * @since BuddyPress (2.2.0)
+ * @since 2.2.0
  *
  * @param array $retval Empty array by default.
@@ -719 +718 @@
  * Set up activity arguments for use with the 'favorites' scope.
  *
- * @since BuddyPress (2.2.0)
+ * @since 2.2.0
  *
  * @param array $retval Empty array by default.
@@ -777 +776 @@
  * Set up activity arguments for use with the 'favorites' scope.
  *
- * @since BuddyPress (2.2.0)
+ * @since 2.2.0
  *
  * @param array $retval Empty array by default.