Changeset 9111

Timestamp:

10/30/2014 11:56:28 PM (10 years ago)

Author:

boonebgorges

Message:

Hook documentation for bp-activity-filters.php.

Props tw2113.
See #5938.

File:

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

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

@@ -114 +114 @@
  * Types of activity stream items to moderate.
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  *
  * @return array $types List of the activity types to moderate.
@@ -123 +123 @@
         'activity_update'
     );
+
+    /**
+     * Filters the default activity types that BuddyPress should moderate.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array $types Default activity types to moderate.
+     */
     return apply_filters( 'bp_activity_check_activity_types', $types );
 }
@@ -129 +137 @@
  * Moderate the posted activity item, if it contains moderate keywords.
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  *
  * @param BP_Activity_Activity $activity The activity object to check.
@@ -148 +156 @@
  * Mark the posted activity as spam, if it contains blacklist keywords.
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  *
  * @param BP_Activity_Activity $activity The activity object to check.
@@ -166 +174 @@
  * Custom kses filtering for activity content.
  *
- * @since BuddyPress (1.1)
+ * @since BuddyPress (1.1.0)
  *
  * @uses apply_filters() To call the 'bp_activity_allowed_tags' hook.
@@ -197 +205 @@
 
 
+    /**
+     * Filters the allowed HTML tags for BuddyPress Activity content.
+     *
+     * @since BuddyPress (1.2.0)
+     *
+     * @param array Array of allowed HTML tags and attributes.
+     */
     $activity_allowedtags = apply_filters( 'bp_activity_allowed_tags', $activity_allowedtags );
     return wp_kses( $content, $activity_allowedtags );
@@ -262 +277 @@
  * hook to send mention notifications after the activity item is saved.
  *
- * @since BuddyPress (1.5)
+ * @since BuddyPress (1.5.0)
  *
  * @uses bp_activity_find_mentions()
@@ -299 +314 @@
  * Sends emails and BP notifications for users @-mentioned in an activity item.
  *
- * @since BuddyPress (1.7)
+ * @since BuddyPress (1.7.0)
  *
  * @uses bp_activity_at_message_notification()
@@ -324 +339 @@
     // Send @mentions and setup BP notifications
     foreach( (array) $usernames as $user_id => $username ) {
-        // If you want to disable notifications, you can use this filter to stop email sending
+        /**
+         * 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.
+         */
         if ( apply_filters( 'bp_activity_at_name_do_notifications', true, $usernames ) ) {
             bp_activity_at_message_notification( $activity->id, $user_id );
@@ -337 +359 @@
  * Catch links in activity text so rel=nofollow can be added.
  *
- * @since BuddyPress (1.2)
+ * @since BuddyPress (1.2.0)
  *
  * @param string $text Activity text.
@@ -349 +371 @@
      * Add rel=nofollow to a link.
      *
-     * @since BuddyPress (1.2)
+     * @since BuddyPress (1.2.0)
      *
      * @param array $matches
@@ -365 +387 @@
  * Truncate long activity entries when viewed in activity streams.
  *
- * @since BuddyPress (1.5)
+ * @since BuddyPress (1.5.0)
  *
  * @uses bp_is_single_activity()
@@ -385 +407 @@
         return $text;
 
+    /**
+     * Filters the appended text for the activity excerpt.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param string $read_more Internationalized "Read more" text.
+     */
     $append_text    = apply_filters( 'bp_activity_excerpt_append_text', __( '[Read more]', 'buddypress' ) );
+
+    /**
+     * 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.
+     */
     $excerpt_length = apply_filters( 'bp_activity_excerpt_length', 358 );
 
@@ -401 +438 @@
     }
 
+    /**
+     * 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.
+     */
     return apply_filters( 'bp_activity_truncate_entry', $excerpt, $text, $append_text );
 }
@@ -553 +599 @@
     $global_pulse = 0;
 
-    // Check whether the global heartbeat settings already exist.
+    /**
+     * Filter that checks whether the global heartbeat settings already exist.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param array $settings Heartbeat settings array.
+     */
     $heartbeat_settings = apply_filters( 'heartbeat_settings', array() );
     if ( ! empty( $heartbeat_settings['interval'] ) ) {
@@ -560 +612 @@
     }
 
-    // Filter here to specify a BP-specific pulse frequency
+    /**
+     * 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.
+     */
     $bp_activity_pulse = apply_filters( 'bp_activity_heartbeat_pulse', 15 );