Changeset 10253

Timestamp:

10/12/2015 05:45:14 AM (9 years ago)

Author:

tw2113

Message:

Further documentation cleanup for Activity Component.

See #6396.

Location:

trunk/src

Files:

• bp-activity/bp-activity-actions.php (modified) (33 diffs)
• bp-activity/bp-activity-admin.php (modified) (85 diffs)
• bp-activity/bp-activity-akismet.php (modified) (25 diffs)
• bp-activity/bp-activity-cache.php (modified) (3 diffs)
• bp-activity/bp-activity-classes.php (modified) (2 diffs)
• bp-activity/bp-activity-cssjs.php (modified) (3 diffs)
• bp-activity/bp-activity-filters.php (modified) (36 diffs)
• bp-activity/bp-activity-functions.php (modified) (93 diffs)
• bp-activity/bp-activity-loader.php (modified) (20 diffs)
• bp-activity/bp-activity-notifications.php (modified) (18 diffs)
• bp-activity/bp-activity-screens.php (modified) (12 diffs)
• bp-activity/bp-activity-template.php (modified) (74 diffs)
• bp-activity/classes/class-bp-activity-activity.php (modified) (82 diffs)
• bp-activity/classes/class-bp-activity-feed.php (modified) (18 diffs)
• bp-activity/classes/class-bp-activity-query.php (modified) (11 diffs)
• bp-blogs/bp-blogs-activity.php (modified) (1 diff)
• bp-members/bp-members-functions.php (modified) (1 diff)

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

@@ -9 +9 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -51 +51 @@
 function bp_activity_action_permalink_router() {
 
-    // Not viewing activity
+    // Not viewing activity.
     if ( ! bp_is_activity_component() || ! bp_is_current_action( 'p' ) )
         return false;
 
-    // No activity to display
+    // No activity to display.
     if ( ! bp_action_variable( 0 ) || ! is_numeric( bp_action_variable( 0 ) ) )
         return false;
 
-    // Get the activity details
+    // Get the activity details.
     $activity = bp_activity_get_specific( array( 'activity_ids' => bp_action_variable( 0 ), 'show_hidden' => true ) );
 
@@ -70 +70 @@
     }
 
-    // Do not redirect at default
+    // Do not redirect at default.
     $redirect = false;
 
-    // Redirect based on the type of activity
+    // Redirect based on the type of activity.
     if ( bp_is_active( 'groups' ) && $activity->component == buddypress()->groups->id ) {
 
-        // Activity is a user update
+        // Activity is a user update.
         if ( ! empty( $activity->user_id ) ) {
             $redirect = bp_core_get_user_domain( $activity->user_id, $activity->user_nicename, $activity->user_login ) . bp_get_activity_slug() . '/' . $activity->id . '/';
 
-        // Activity is something else
+        // Activity is something else.
         } else {
 
-            // Set redirect to group activity stream
+            // Set redirect to group activity stream.
             if ( $group = groups_get_group( array( 'group_id' => $activity->item_id ) ) ) {
                 $redirect = bp_get_group_permalink( $group ) . bp_get_activity_slug() . '/' . $activity->id . '/';
@@ -89 +89 @@
         }
 
-    // Set redirect to users' activity stream
+    // Set redirect to users' activity stream.
     } elseif ( ! empty( $activity->user_id ) ) {
         $redirect = bp_core_get_user_domain( $activity->user_id, $activity->user_nicename, $activity->user_login ) . bp_get_activity_slug() . '/' . $activity->id . '/';
     }
 
-    // If set, add the original query string back onto the redirect URL
+    // If set, add the original query string back onto the redirect URL.
     if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
         $query_frags = array();
@@ -112 +112 @@
     }
 
-    // Redirect to the actual activity permalink page
+    // Redirect to the actual activity permalink page.
     bp_core_redirect( $redirect );
 }
@@ -121 +121 @@
  *
  * @since 1.1.0
- *
- * @param int $activity_id Activity id to be deleted. Defaults to 0.
  *
  * @uses bp_is_activity_component()
@@ -135 +133 @@
  * @uses bp_core_redirect()
  *
+ * @param int $activity_id Activity id to be deleted. Defaults to 0.
  * @return bool False on failure.
  */
 function bp_activity_action_delete_activity( $activity_id = 0 ) {
 
-    // Not viewing activity or action is not delete
+    // Not viewing activity or action is not delete.
     if ( !bp_is_activity_component() || !bp_is_current_action( 'delete' ) )
         return false;
@@ -146 +145 @@
         $activity_id = (int) bp_action_variable( 0 );
 
-    // Not viewing a specific activity item
+    // Not viewing a specific activity item.
     if ( empty( $activity_id ) )
         return false;
 
-    // Check the nonce
+    // Check the nonce.
     check_admin_referer( 'bp_activity_delete_link' );
 
-    // Load up the activity item
+    // Load up the activity item.
     $activity = new BP_Activity_Activity( $activity_id );
 
-    // Check access
+    // Check access.
     if ( ! bp_activity_user_can_delete( $activity ) )
         return false;
@@ -170 +169 @@
     do_action( 'bp_activity_before_action_delete_activity', $activity_id, $activity->user_id );
 
-    // Delete the activity item and provide user feedback
+    // Delete the activity item and provide user feedback.
     if ( bp_activity_delete( array( 'id' => $activity_id, 'user_id' => $activity->user_id ) ) )
         bp_core_add_message( __( 'Activity deleted successfully', 'buddypress' ) );
@@ -186 +185 @@
     do_action( 'bp_activity_action_delete_activity', $activity_id, $activity->user_id );
 
-    // Check for the redirect query arg, otherwise let WP handle things
+    // Check for the redirect query arg, otherwise let WP handle things.
     if ( !empty( $_GET['redirect_to'] ) )
         bp_core_redirect( esc_url( $_GET['redirect_to'] ) );
@@ -200 +199 @@
  *
  * @param int $activity_id Activity id to be deleted. Defaults to 0.
- *
  * @return bool False on failure.
  */
@@ -206 +204 @@
     $bp = buddypress();
 
-    // Not viewing activity, or action is not spam, or Akismet isn't present
+    // Not viewing activity, or action is not spam, or Akismet isn't present.
     if ( !bp_is_activity_component() || !bp_is_current_action( 'spam' ) || empty( $bp->activity->akismet ) )
         return false;
@@ -213 +211 @@
         $activity_id = (int) bp_action_variable( 0 );
 
-    // Not viewing a specific activity item
+    // Not viewing a specific activity item.
     if ( empty( $activity_id ) )
         return false;
@@ -221 +219 @@
         return false;
 
-    // Load up the activity item
+    // Load up the activity item.
     $activity = new BP_Activity_Activity( $activity_id );
     if ( empty( $activity->id ) )
         return false;
 
-    // Check nonce
+    // Check nonce.
     check_admin_referer( 'bp_activity_akismet_spam_' . $activity->id );
 
@@ -239 +237 @@
     do_action( 'bp_activity_before_action_spam_activity', $activity->id, $activity );
 
-    // Mark as spam
+    // Mark as spam.
     bp_activity_mark_as_spam( $activity );
     $activity->save();
 
-    // Tell the user the spamming has been successful
+    // Tell the user the spamming has been successful.
     bp_core_add_message( __( 'The activity item has been marked as spam and is no longer visible.', 'buddypress' ) );
 
@@ -256 +254 @@
     do_action( 'bp_activity_action_spam_activity', $activity_id, $activity->user_id );
 
-    // Check for the redirect query arg, otherwise let WP handle things
+    // Check for the redirect query arg, otherwise let WP handle things.
     if ( !empty( $_GET['redirect_to'] ) )
         bp_core_redirect( esc_url( $_GET['redirect_to'] ) );
@@ -287 +285 @@
 function bp_activity_action_post_update() {
 
-    // Do not proceed if user is not logged in, not viewing activity, or not posting
+    // Do not proceed if user is not logged in, not viewing activity, or not posting.
     if ( !is_user_logged_in() || !bp_is_activity_component() || !bp_is_current_action( 'post' ) )
         return false;
 
-    // Check the nonce
+    // Check the nonce.
     check_admin_referer( 'post_update', '_wpnonce_post_update' );
 
@@ -327 +325 @@
     }
 
-    // No activity content so provide feedback and redirect
+    // No activity content so provide feedback and redirect.
     if ( empty( $content ) ) {
         bp_core_add_message( __( 'Please enter some content to post.', 'buddypress' ), 'error' );
@@ -333 +331 @@
     }
 
-    // No existing item_id
+    // No existing item_id.
     if ( empty( $item_id ) ) {
         $activity_id = bp_activity_post_update( array( 'content' => $content ) );
 
-    // Post to groups object
+    // Post to groups object.
     } elseif ( 'groups' == $object && bp_is_active( 'groups' ) ) {
         if ( (int) $item_id ) {
@@ -357 +355 @@
     }
 
-    // Provide user feedback
+    // Provide user feedback.
     if ( !empty( $activity_id ) )
         bp_core_add_message( __( 'Update Posted!', 'buddypress' ) );
@@ -363 +361 @@
         bp_core_add_message( __( 'There was an error when posting your update. Please try again.', 'buddypress' ), 'error' );
 
-    // Redirect
+    // Redirect.
     bp_core_redirect( wp_get_referer() );
 }
@@ -391 +389 @@
         return false;
 
-    // Check the nonce
+    // Check the nonce.
     check_admin_referer( 'new_activity_comment', '_wpnonce_new_activity_comment' );
 
@@ -454 +452 @@
         return false;
 
-    // Check the nonce
+    // Check the nonce.
     check_admin_referer( 'mark_favorite' );
 
@@ -488 +486 @@
         return false;
 
-    // Check the nonce
+    // Check the nonce.
     check_admin_referer( 'unmark_favorite' );
 
@@ -518 +516 @@
         return false;
 
-    // setup the feed
+    // Setup the feed.
     buddypress()->activity->feed = new BP_Activity_Feed( array(
         'id'            => 'sitewide',
@@ -548 +546 @@
     }
 
-    // setup the feed
+    // Setup the feed.
     buddypress()->activity->feed = new BP_Activity_Feed( array(
         'id'            => 'personal',
@@ -581 +579 @@
     }
 
-    // setup the feed
+    // Setup the feed.
     buddypress()->activity->feed = new BP_Activity_Feed( array(
         'id'            => 'friends',
@@ -614 +612 @@
     }
 
-    // get displayed user's group IDs
+    // Get displayed user's group IDs.
     $groups    = groups_get_user_groups();
     $group_ids = implode( ',', $groups['groups'] );
 
-    // setup the feed
+    // Setup the feed.
     buddypress()->activity->feed = new BP_Activity_Feed( array(
         'id'            => 'mygroups',
@@ -657 +655 @@
     }
 
-    // setup the feed
+    // Setup the feed.
     buddypress()->activity->feed = new BP_Activity_Feed( array(
         'id'            => 'mentions',
@@ -690 +688 @@
     }
 
-    // get displayed user's favorite activity IDs
+    // Get displayed user's favorite activity IDs.
     $favs = bp_activity_get_user_favorites( bp_displayed_user_id() );
     $fav_ids = implode( ',', (array) $favs );
 
-    // setup the feed
+    // Setup the feed.
     buddypress()->activity->feed = new BP_Activity_Feed( array(
         'id'            => 'favorites',
@@ -717 +715 @@
     $bp = buddypress();
 
-    // Bail if Akismet is not active
+    // Bail if Akismet is not active.
     if ( ! defined( 'AKISMET_VERSION' ) ) {
         return;
     }
 
-    // Bail if older version of Akismet
+    // Bail if older version of Akismet.
     if ( ! class_exists( 'Akismet' ) ) {
         return;
     }
 
-    // Bail if no Akismet key is set
+    // Bail if no Akismet key is set.
     if ( ! bp_get_option( 'wordpress_api_key' ) && ! defined( 'WPCOM_API_KEY' ) ) {
         return;
@@ -743 +741 @@
     }
 
-    // Instantiate Akismet for BuddyPress
+    // Instantiate Akismet for BuddyPress.
     $bp->activity->akismet = new BP_Akismet();
 }
@@ -828 +826 @@
     // Unpublishing a previously published post.
     } elseif ( 'publish' === $old_status ) {
-        // Some form of pending status - only remove the activity entry
+        // Some form of pending status - only remove the activity entry.
         bp_activity_post_type_unpublish( $post->ID, $post );
     }

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

@@ -6 +6 @@
  * help text, on which this implementation is heavily based.
  *
- * @since 1.6.0
  * @package BuddyPress
  * @subpackage ActivityAdmin
+ * @since 1.6.0
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
-// Include WP's list table class
+// Include WP's list table class.
 if ( !class_exists( 'WP_List_Table' ) ) require( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
 
-// per_page screen option. Has to be hooked in extremely early.
+// Per_page screen option. Has to be hooked in extremely early.
 if ( is_admin() && ! empty( $_REQUEST['page'] ) && 'bp-activity' == $_REQUEST['page'] )
     add_filter( 'set-screen-option', 'bp_activity_admin_screen_options', 10, 3 );
@@ -28 +28 @@
 function bp_activity_add_admin_menu() {
 
-    // Add our screen
+    // Add our screen.
     $hook = add_menu_page(
         _x( 'Activity', 'Admin Dashbord SWA page title', 'buddypress' ),
@@ -53 +53 @@
  *
  * @param array $custom_menus The list of top-level BP menu items.
- *
  * @return array $custom_menus List of top-level BP menu items, with Activity added.
  */
@@ -71 +70 @@
  */
 function bp_activity_admin_reply() {
-    // Check nonce
+    // Check nonce.
     check_ajax_referer( 'bp-activity-admin-reply', '_ajax_nonce-bp-activity-admin-reply' );
 
@@ -81 +80 @@
         die( '-1' );
 
-    // If $root_id not set (e.g. for root items), use $parent_id
+    // If $root_id not set (e.g. for root items), use $parent_id.
     if ( empty( $root_id ) )
         $root_id = $parent_id;
 
-    // Check that a reply has been entered
+    // Check that a reply has been entered.
     if ( empty( $_REQUEST['content'] ) )
         die( __( 'ERROR: Please type a reply.', 'buddypress' ) );
 
-    // Check parent activity exists
+    // Check parent activity exists.
     $parent_activity = new BP_Activity_Activity( $parent_id );
     if ( empty( $parent_activity->component ) )
@@ -99 +98 @@
         die( '-1' );
 
-    // Add new activity comment
+    // Add new activity comment.
     $new_activity_id = bp_activity_new_comment( array(
-        'activity_id' => $root_id,              // ID of the root activity item
+        'activity_id' => $root_id,              // ID of the root activity item.
         'content'     => $_REQUEST['content'],
-        'parent_id'   => $parent_id,            // ID of a parent comment
+        'parent_id'   => $parent_id,            // ID of a parent comment.
     ) );
 
-    // Fetch the new activity item, as we need it to create table markup to return
+    // Fetch the new activity item, as we need it to create table markup to return.
     $new_activity = new BP_Activity_Activity( $new_activity_id );
 
-    // This needs to be set for the BP_Activity_List_Table constructor to work
+    // This needs to be set for the BP_Activity_List_Table constructor to work.
     set_current_screen( 'toplevel_page_bp-activity' );
 
-    // Set up an output buffer
+    // Set up an output buffer.
     ob_start();
     $list_table = new BP_Activity_List_Table();
     $list_table->single_row( (array) $new_activity );
 
-    // Get table markup
+    // Get table markup.
     $response =  array(
         'data'     => ob_get_contents(),
@@ -126 +125 @@
     ob_end_clean();
 
-    // Send response
+    // Send response.
     $r = new WP_Ajax_Response();
     $r->add( $response );
@@ -143 +142 @@
  * @param string $option    Screen option name.
  * @param string $new_value Screen option form value.
- *
  * @return string Option value. False to abandon update.
  */
@@ -150 +148 @@
         return $value;
 
-    // Per page
+    // Per page.
     $new_value = (int) $new_value;
     if ( $new_value < 1 || $new_value > 999 )
@@ -165 +163 @@
  * @param array     $hidden Array of items to hide.
  * @param WP_Screen $screen Screen identifier.
- *
  * @return array Hidden Meta Boxes.
  */
@@ -172 +169 @@
         return $hidden;
 
-    // Hide the primary link meta box by default
+    // Hide the primary link meta box by default.
     $hidden  = array_merge( (array) $hidden, array( 'bp_activity_itemids', 'bp_activity_link', 'bp_activity_type', 'bp_activity_userid', ) );
 
@@ -205 +202 @@
     $bp = buddypress();
 
-    // Decide whether to load the dev version of the CSS and JavaScript
+    // Decide whether to load the dev version of the CSS and JavaScript.
     $min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : 'min.';
 
@@ -219 +216 @@
     do_action( 'bp_activity_admin_load', $doaction );
 
-    // Edit screen
+    // Edit screen.
     if ( 'edit' == $doaction && ! empty( $_GET['aid'] ) ) {
-        // columns screen option
+        // Columns screen option.
         add_screen_option( 'layout_columns', array( 'default' => 2, 'max' => 2, ) );
 
@@ -243 +240 @@
         ) );
 
-        // Help panel - sidebar links
+        // Help panel - sidebar links.
         get_current_screen()->set_help_sidebar(
             '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
@@ -264 +261 @@
         do_action( 'bp_activity_admin_meta_boxes' );
 
-        // Enqueue JavaScript files
+        // Enqueue JavaScript files.
         wp_enqueue_script( 'postbox' );
         wp_enqueue_script( 'dashboard' );
         wp_enqueue_script( 'comment' );
 
-    // Index screen
+    // Index screen.
     } else {
-        // Create the Activity screen list table
+        // Create the Activity screen list table.
         $bp_activity_list_table = new BP_Activity_List_Table();
 
-        // per_page screen option
+        // The per_page screen option.
         add_screen_option( 'per_page', array( 'label' => _x( 'Activity', 'Activity items per page (screen options)', 'buddypress' )) );
 
-        // Help panel - overview text
+        // Help panel - overview text.
         get_current_screen()->add_help_tab( array(
             'id'      => 'bp-activity-overview',
@@ -286 +283 @@
         ) );
 
-        // Help panel - moderation text
+        // Help panel - moderation text.
         get_current_screen()->add_help_tab( array(
             'id'        => 'bp-activity-moderating',
@@ -295 +292 @@
         ) );
 
-        // Help panel - sidebar links
+        // Help panel - sidebar links.
         get_current_screen()->set_help_sidebar(
             '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
@@ -302 +299 @@
     }
 
-    // Enqueue CSS and JavaScript
+    // Enqueue CSS and JavaScript.
     wp_enqueue_script( 'bp_activity_admin_js', $bp->plugin_url . "bp-activity/admin/js/admin.{$min}js",   array( 'jquery', 'wp-ajax-response' ), bp_get_version(), true );
     wp_localize_script( 'bp_activity_admin_js', 'bp_activity_admin_vars', array(
@@ -321 +318 @@
     do_action( 'bp_activity_admin_enqueue_scripts' );
 
-    // Handle spam/un-spam/delete of activities
+    // Handle spam/un-spam/delete of activities.
     if ( !empty( $doaction ) && ! in_array( $doaction, array( '-1', 'edit', 'save', ) ) ) {
 
-        // Build redirection URL
+        // Build redirection URL.
         $redirect_to = remove_query_arg( array( 'aid', 'deleted', 'error', 'spammed', 'unspammed', ), wp_get_referer() );
         $redirect_to = add_query_arg( 'paged', $bp_activity_list_table->get_pagenum(), $redirect_to );
 
-        // Get activity IDs
+        // Get activity IDs.
         $activity_ids = array_map( 'absint', (array) $_REQUEST['aid'] );
 
@@ -342 +339 @@
         // Is this a bulk request?
         if ( 'bulk_' == substr( $doaction, 0, 5 ) && ! empty( $_REQUEST['aid'] ) ) {
-            // Check this is a valid form submission
+            // Check this is a valid form submission.
             check_admin_referer( 'bulk-activities' );
 
-            // Trim 'bulk_' off the action name to avoid duplicating a ton of code
+            // Trim 'bulk_' off the action name to avoid duplicating a ton of code.
             $doaction = substr( $doaction, 5 );
 
@@ -351 +348 @@
         } elseif ( !empty( $_REQUEST['aid'] ) ) {
 
-            // Check this is a valid form submission
+            // Check this is a valid form submission.
             check_admin_referer( 'spam-activity_' . $activity_ids[0] );
         }
 
-        // Initialise counters for how many of each type of item we perform an action on
+        // Initialise counters for how many of each type of item we perform an action on.
         $deleted = $spammed = $unspammed = 0;
 
-        // Store any errors that occurs when updating the database items
+        // Store any errors that occurs when updating the database items.
         $errors = array();
 
@@ -365 +362 @@
             // @todo: Check the permissions on each
             //if ( ! current_user_can( 'bp_edit_activity', $activity_id ) )
-            //  continue;
-
-            // Get the activity from the database
+            // continue;
+
+            // Get the activity from the database.
             $activity = new BP_Activity_Activity( $activity_id );
             if ( empty( $activity->component ) ) {
@@ -395 +392 @@
                     $result = $activity->save();
 
-                    // Check for any error during activity save
+                    // Check for any error during activity save.
                     if ( ! $result )
                         $errors[] = $activity->id;
@@ -406 +403 @@
                     $result = $activity->save();
 
-                    // Check for any error during activity save
+                    // Check for any error during activity save.
                     if ( ! $result )
                         $errors[] = $activity->id;
@@ -417 +414 @@
             }
 
-            // Release memory
+            // Release memory.
             unset( $activity );
         }
@@ -444 +441 @@
             $redirect_to = add_query_arg( 'deleted', $deleted, $redirect_to );
 
-        // If an error occurred, pass back the activity ID that failed
+        // If an error occurred, pass back the activity ID that failed.
         if ( ! empty( $errors ) )
             $redirect_to = add_query_arg( 'error', implode ( ',', array_map( 'absint', $errors ) ), $redirect_to );
@@ -459 +456 @@
 
 
-    // Save the edit
+    // Save the edit.
     } elseif ( $doaction && 'save' == $doaction ) {
-        // Build redirection URL
+        // Build redirection URL.
         $redirect_to = remove_query_arg( array( 'action', 'aid', 'deleted', 'error', 'spammed', 'unspammed', ), $_SERVER['REQUEST_URI'] );
 
-        // Get activity ID
+        // Get activity ID.
         $activity_id = (int) $_REQUEST['aid'];
 
-        // Check this is a valid form submission
+        // Check this is a valid form submission.
         check_admin_referer( 'edit-activity_' . $activity_id );
 
-        // Get the activity from the database
+        // Get the activity from the database.
         $activity = new BP_Activity_Activity( $activity_id );
 
-        // If the activity doesn't exist, just redirect back to the index
+        // If the activity doesn't exist, just redirect back to the index.
         if ( empty( $activity->component ) ) {
             wp_redirect( $redirect_to );
@@ -479 +476 @@
         }
 
-        // Check the form for the updated properties
-
-        // Store any error that occurs when updating the database item
+        // Check the form for the updated properties.
+        // Store any error that occurs when updating the database item.
         $error = 0;
 
-        // Activity spam status
+        // Activity spam status.
         $prev_spam_status = $new_spam_status = false;
         if ( ! empty( $_POST['activity_status'] ) ) {
@@ -491 +487 @@
         }
 
-        // Activity action
+        // Activity action.
         if ( isset( $_POST['bp-activities-action'] ) )
             $activity->action = $_POST['bp-activities-action'];
 
-        // Activity content
+        // Activity content.
         if ( isset( $_POST['bp-activities-content'] ) )
             $activity->content = $_POST['bp-activities-content'];
 
-        // Activity primary link
+        // Activity primary link.
         if ( ! empty( $_POST['bp-activities-link'] ) )
             $activity->primary_link = $_POST['bp-activities-link'];
 
-        // Activity user ID
+        // Activity user ID.
         if ( ! empty( $_POST['bp-activities-userid'] ) )
             $activity->user_id = (int) $_POST['bp-activities-userid'];
 
-        // Activity item primary ID
+        // Activity item primary ID.
         if ( isset( $_POST['bp-activities-primaryid'] ) )
             $activity->item_id = (int) $_POST['bp-activities-primaryid'];
 
-        // Activity item secondary ID
+        // Activity item secondary ID.
         if ( isset( $_POST['bp-activities-secondaryid'] ) )
             $activity->secondary_item_id = (int) $_POST['bp-activities-secondaryid'];
 
-        // Activity type
+        // Activity type.
         if ( ! empty( $_POST['bp-activities-type'] ) ) {
             $actions = bp_activity_admin_get_activity_actions();
 
-            // Check that the new type is a registered activity type
+            // Check that the new type is a registered activity type.
             if ( in_array( $_POST['bp-activities-type'], $actions ) ) {
                 $activity->type = $_POST['bp-activities-type'];
@@ -525 +521 @@
         }
 
-        // Activity timestamp
+        // Activity timestamp.
         if ( ! empty( $_POST['aa'] ) && ! empty( $_POST['mm'] ) && ! empty( $_POST['jj'] ) && ! empty( $_POST['hh'] ) && ! empty( $_POST['mn'] ) && ! empty( $_POST['ss'] ) ) {
             $aa = $_POST['aa'];
@@ -541 +537 @@
             $ss = ( $ss > 59 ) ? $ss -60 : $ss;
 
-            // Reconstruct the date into a timestamp
+            // Reconstruct the date into a timestamp.
             $gmt_date = sprintf( "%04d-%02d-%02d %02d:%02d:%02d", $aa, $mm, $jj, $hh, $mn, $ss );
 
@@ -555 +551 @@
         }
 
-        // Save
+        // Save.
         $result = $activity->save();
 
-        // Clear the activity stream first page cache, in case this activity's timestamp was changed
+        // Clear the activity stream first page cache, in case this activity's timestamp was changed.
         wp_cache_delete( 'bp_activity_sitewide_front', 'bp' );
 
-        // Check for any error during activity save
+        // Check for any error during activity save.
         if ( false === $result )
             $error = $activity->id;
@@ -574 +570 @@
         do_action_ref_array( 'bp_activity_admin_edit_after', array( &$activity, $error ) );
 
-        // If an error occurred, pass back the activity ID that failed
+        // If an error occurred, pass back the activity ID that failed.
         if ( $error )
             $redirect_to = add_query_arg( 'error', (int) $error, $redirect_to );
@@ -604 +600 @@
  */
 function bp_activity_admin() {
-    // Decide whether to load the index or edit screen
+    // Decide whether to load the index or edit screen.
     $doaction = ! empty( $_REQUEST['action'] ) ? $_REQUEST['action'] : '';
 
-    // Display the single activity edit screen
+    // Display the single activity edit screen.
     if ( 'edit' == $doaction && ! empty( $_GET['aid'] ) )
         bp_activity_admin_edit();
 
-    // Otherwise, display the Activity index screen
+    // Otherwise, display the Activity index screen.
     else
         bp_activity_admin_index();
@@ -628 +624 @@
         die( '-1' );
 
-    // Get the activity from the database
+    // Get the activity from the database.
     $activity = bp_activity_get( array(
         'in'               => ! empty( $_REQUEST['aid'] ) ? (int) $_REQUEST['aid'] : 0,
@@ -640 +636 @@
         $activity = $activity['activities'][0];
 
-        // Workaround to use WP's touch_time() without duplicating that function
+        // Workaround to use WP's touch_time() without duplicating that function.
         $GLOBALS['comment'] = new stdClass;
         $GLOBALS['comment']->comment_date = $activity->date_recorded;
@@ -647 +643 @@
     }
 
-    // Construct URL for form
+    // Construct URL for form.
     $form_url = remove_query_arg( array( 'action', 'deleted', 'error', 'spammed', 'unspammed', ), $_SERVER['REQUEST_URI'] );
     $form_url = add_query_arg( 'action', 'save', $form_url );
@@ -741 +737 @@
                 <div class="misc-pub-section curtime misc-pub-section-last">
                     <?php
-                    // translators: Publish box date format, see http://php.net/date
+                    // Translators: Publish box date format, see http://php.net/date.
                     $datef = __( 'M j, Y @ G:i', 'buddypress' );
                     $date  = date_i18n( $datef, strtotime( $item->date_recorded ) );
@@ -808 +804 @@
  * @since 2.0.0
  *
- * @return array
+ * @return array $actions
  */
 function bp_activity_admin_get_activity_actions() {
@@ -822 +818 @@
     }
 
-    // This was a mis-named activity type from before BP 1.6
+    // This was a mis-named activity type from before BP 1.6.
     unset( $actions['friends_register_activity_action'] );
 
-    // Sort array by the human-readable value
+    // Sort array by the human-readable value.
     natsort( $actions );
 
@@ -852 +848 @@
     }
 
-    // This was a mis-named activity type from before BP 1.6
+    // This was a mis-named activity type from before BP 1.6.
     unset( $actions['friends_register_activity_action'] );
 
-    // Sort array by the human-readable value
+    // Sort array by the human-readable value.
     natsort( $actions );
 
-    // If the activity type is not registered properly (eg, a plugin has
-    // not called bp_activity_set_action()), add the raw type to the end
-    // of the list
+    /*
+     * If the activity type is not registered properly (eg, a plugin has
+     * not called bp_activity_set_action()), add the raw type to the end
+     * of the list.
+     */
     if ( ! isset( $actions[ $selected ] ) ) {
         _doing_it_wrong( __FUNCTION__, sprintf( __( 'This activity item has a type (%s) that is not registered using bp_activity_set_action(), so no label is available.', 'buddypress' ), $selected ), '2.0.0' );
@@ -912 +910 @@
     $messages = array();
 
-    // If the user has just made a change to an activity item, build status messages
+    // If the user has just made a change to an activity item, build status messages.
     if ( ! empty( $_REQUEST['deleted'] ) || ! empty( $_REQUEST['spammed'] ) || ! empty( $_REQUEST['unspammed'] ) || ! empty( $_REQUEST['error'] ) || ! empty( $_REQUEST['updated'] ) ) {
         $deleted   = ! empty( $_REQUEST['deleted']   ) ? (int) $_REQUEST['deleted']   : 0;
@@ -922 +920 @@
         $errors = array_map( 'absint', explode( ',', $errors ) );
 
-        // Make sure we don't get any empty values in $errors
+        // Make sure we don't get any empty values in $errors.
         for ( $i = 0, $errors_count = count( $errors ); $i < $errors_count; $i++ ) {
             if ( 0 === $errors[$i] ) {
@@ -929 +927 @@
         }
 
-        // Reindex array
+        // Reindex array.
         $errors = array_values( $errors );
 
@@ -943 +941 @@
                 $error_msg .= '<ul class="activity-errors">';
 
-                // Display each error as a list item
+                // Display each error as a list item.
                 foreach ( $errors as $error ) {
-                    // Translators: This is a bulleted list of item IDs
+                    // Translators: This is a bulleted list of item IDs.
                     $error_msg .= '<li>' . sprintf( __( '#%s', 'buddypress' ), number_format_i18n( $error ) ) . '</li>';
                 }
@@ -964 +962 @@
     }
 
-    // Prepare the activity items for display
+    // Prepare the activity items for display.
     $bp_activity_list_table->prepare_items();
 
@@ -989 +987 @@
         </h2>
 
-        <?php // If the user has just made a change to an activity item, display the status messages ?>
+        <?php // If the user has just made a change to an activity item, display the status messages. ?>
         <?php if ( !empty( $messages ) ) : ?>
             <div id="moderated" class="<?php echo ( ! empty( $_REQUEST['error'] ) ) ? 'error' : 'updated'; ?>"><p><?php echo implode( "<br/>\n", $messages ); ?></p></div>
         <?php endif; ?>
 
-        <?php // Display each activity on its own row ?>
+        <?php // Display each activity on its own row. ?>
         <?php $bp_activity_list_table->views(); ?>
 
@@ -1003 +1001 @@
         </form>
 
-        <?php // This markup is used for the reply form ?>
+        <?php // This markup is used for the reply form. ?>
         <table style="display: none;">
             <tr id="bp-activities-container" style="display: none;">
@@ -1042 +1040 @@
      * What type of view is being displayed?
      *
-     * e.g. "all", "pending", "approved", "spam"...
-     *
-     * @since 1.6.0
-     * @var string
+     * E.g. "all", "pending", "approved", "spam"...
+     *
+     * @since 1.6.0
+     * @var string $view
      */
     public $view = 'all';
@@ -1053 +1051 @@
      *
      * @since 1.6.0
-     * @var int
+     * @var int $spam_count
      */
     public $spam_count = 0;
@@ -1061 +1059 @@
      *
      * @since 1.6.0
-     * @var array
+     * @var array $activity_user_id
      */
     protected $activity_user_id = array();
@@ -1068 +1066 @@
      * If users can comment on blog & forum activity items.
      *
+     * @link https://buddypress.trac.wordpress.org/ticket/6277
+     *
      * @since 2.2.2
-     *
-     * @link https://buddypress.trac.wordpress.org/ticket/6277
-     *
-     * @var bool
+     * @var bool $disable_blogforum_comments
      */
     public $disable_blogforum_comments = false;
@@ -1083 +1080 @@
     public function __construct() {
 
-        // See if activity commenting is enabled for blog / forum activity items
+        // See if activity commenting is enabled for blog / forum activity items.
         $this->disable_blogforum_comments = bp_disable_blogforum_comments();
 
@@ -1102 +1099 @@
     function prepare_items() {
 
-        // Option defaults
+        // Option defaults.
         $filter           = array();
         $include_id       = false;
@@ -1109 +1106 @@
         $spam             = 'ham_only';
 
-        // Set current page
+        // Set current page.
         $page = $this->get_pagenum();
 
-        // Set per page from the screen options
+        // Set per page from the screen options.
         $per_page = $this->get_items_per_page( str_replace( '-', '_', "{$this->screen->id}_per_page" ) );
 
-        // Check if we're on the "Spam" view
+        // Check if we're on the "Spam" view.
         if ( !empty( $_REQUEST['activity_status'] ) && 'spam' == $_REQUEST['activity_status'] ) {
             $spam       = 'spam_only';
@@ -1121 +1118 @@
         }
 
-        // Sort order
+        // Sort order.
         if ( !empty( $_REQUEST['order'] ) && 'desc' != $_REQUEST['order'] )
             $sort = 'ASC';
 
-        // Order by
+        // Order by.
         /*if ( !empty( $_REQUEST['orderby'] ) ) {
         }*/
 
-        // Filter
+        // Filter.
         if ( !empty( $_REQUEST['activity_type'] ) )
             $filter = array( 'action' => $_REQUEST['activity_type'] );
@@ -1141 +1138 @@
             $include_id = (int) $_REQUEST['aid'];
 
-        // Get the spam total (ignoring any search query or filter)
+        // Get the spam total (ignoring any search query or filter).
         $spams = bp_activity_get( array(
             'display_comments' => 'stream',
@@ -1151 +1148 @@
         unset( $spams );
 
-        // Get the activities from the database
+        // Get the activities from the database.
         $activities = bp_activity_get( array(
             'display_comments' => 'stream',
@@ -1160 +1157 @@
             'search_terms'     => $search_terms,
             'show_hidden'      => true,
-            //'sort'             => $sort,
+            // 'sort'             => $sort,
             'spam'             => $spam,
             'count_total'      => 'count_query',
@@ -1170 +1167 @@
             $activities['total']      = count( $activities['activities'] );
 
-            // Sort the array by the activity object's date_recorded value
+            // Sort the array by the activity object's date_recorded value.
             usort( $activities['activities'], create_function( '$a, $b', 'return $a->date_recorded > $b->date_recorded;' ) );
         }
 
-        // bp_activity_get returns an array of objects; cast these to arrays for WP_List_Table.
+        // The bp_activity_get function returns an array of objects; cast these to arrays for WP_List_Table.
         $new_activities = array();
         foreach ( $activities['activities'] as $activity_item ) {
             $new_activities[] = (array) $activity_item;
 
-            // Build an array of activity-to-user ID mappings for better efficiency in the In Response To column
+            // Build an array of activity-to-user ID mappings for better efficiency in the In Response To column.
             $this->activity_user_id[$activity_item->id] = $activity_item->user_id;
         }
 
-        // Set raw data to display
+        // Set raw data to display.
         $this->items       = $new_activities;
 
-        // Store information needed for handling table pagination
+        // Store information needed for handling table pagination.
         $this->set_pagination_args( array(
             'per_page'    => $per_page,
@@ -1239 +1236 @@
      *
      * @since 1.6.0
-    */
+     */
     function display() {
         $this->display_tablenav( 'top' ); ?>
@@ -1398 +1395 @@
     function extra_tablenav( $which ) {
 
-        // Bail on bottom table nav
+        // Bail on bottom table nav.
         if ( 'bottom' === $which ) {
             return;
@@ -1406 +1403 @@
         $selected = ( ! empty( $_REQUEST['activity_type'] ) ) ? $_REQUEST['activity_type'] : '';
 
-        // Get the actions
+        // Get the actions.
         $activity_actions = bp_activity_get_actions(); ?>
 
@@ -1422 +1419 @@
                             <?php
 
-                            // Skip the incorrectly named pre-1.6 action
+                            // Skip the incorrectly named pre-1.6 action.
                             if ( 'friends_register_activity_action' !== $action_key ) : ?>
 
@@ -1452 +1449 @@
      * @since 2.3.4 Visibility set to public for compatibility with WP < 4.0.0.
      *
-     * @param array $actions The list of actions
-     * @param bool $always_visible Whether the actions should be always visible
+     * @param array $actions The list of actions.
+     * @param bool  $always_visible Whether the actions should be always visible.
      * @return string
      */
@@ -1531 +1528 @@
      */
     function column_comment( $item ) {
-        // Determine what type of item (row) we're dealing with
+        // Determine what type of item (row) we're dealing with.
         if ( $item['is_spam'] )
             $item_status = 'spam';
@@ -1537 +1534 @@
             $item_status = 'all';
 
-        // Preorder items: Reply | Edit | Spam | Delete Permanently
+        // Preorder items: Reply | Edit | Spam | Delete Permanently.
         $actions = array(
             'reply'  => '',
@@ -1545 +1542 @@
         );
 
-        // Build actions URLs
+        // Build actions URLs.
         $base_url   = bp_get_admin_url( 'admin.php?page=bp-activity&amp;aid=' . $item['id'] );
         $spam_nonce = esc_html( '_wpnonce=' . wp_create_nonce( 'spam-activity_' . $item['id'] ) );
@@ -1554 +1551 @@
         $spam_url   = $base_url . "&amp;action=spam&amp;$spam_nonce";
 
-        // Rollover actions
-
+        // Rollover actions.
         // Reply - JavaScript only; implemented by AJAX.
         if ( 'spam' != $item_status ) {
@@ -1564 +1560 @@
             }
 
-            // Edit
+            // Edit.
             $actions['edit'] = sprintf( '<a href="%s">%s</a>', $edit_url, __( 'Edit', 'buddypress' ) );
         }
 
-        // Spam/unspam
+        // Spam/unspam.
         if ( 'spam' == $item_status )
             $actions['unspam'] = sprintf( '<a href="%s">%s</a>', $ham_url, __( 'Not Spam', 'buddypress' ) );
@@ -1574 +1570 @@
             $actions['spam'] = sprintf( '<a href="%s">%s</a>', $spam_url, __( 'Spam', 'buddypress' ) );
 
-        // Delete
+        // Delete.
         $actions['delete'] = sprintf( '<a href="%s" onclick="%s">%s</a>', $delete_url, "javascript:return confirm('" . esc_js( __( 'Are you sure?', 'buddypress' ) ) . "'); ", __( 'Delete Permanently', 'buddypress' ) );
 
-        // Start timestamp
+        // Start timestamp.
         echo '<div class="submitted-on">';
 
@@ -1598 +1594 @@
         );
 
-        // End timestamp
+        // End timestamp.
         echo '</div>';
 
-        // Get activity content - if not set, use the action
+        // Get activity content - if not set, use the action.
         if ( ! empty( $item['content'] ) ) {
 
@@ -1624 +1620 @@
 
         /**
-         * Filter here to add extra output to the activity content into the Administration
+         * Filter here to add extra output to the activity content into the Administration.
          *
          * @since  2.4.0
          *
-         * @param  string $content The activity content
-         * @param  array  $item    The activity object converted into an array
+         * @param  string $content The activity content.
+         * @param  array  $item    The activity object converted into an array.
          */
         echo apply_filters( 'bp_activity_admin_comment_content', $content, $item ) . ' ' . $this->row_actions( $actions );
@@ -1644 +1640 @@
      */
     function column_response( $item ) {
+
         // Is $item is a root activity?
         ?>
@@ -1670 +1667 @@
             $root_activity_url = bp_get_admin_url( 'admin.php?page=bp-activity&amp;aid=' . $item['id'] );
 
-            // If the activity has comments, display a link to the activity's permalink, with its comment count in a speech bubble
+            // If the activity has comments, display a link to the activity's permalink, with its comment count in a speech bubble.
             if ( $comment_count ) {
                 $title_attr = sprintf( _n( '%s related activity', '%s related activities', $comment_count, 'buddypress' ), number_format_i18n( $comment_count ) );
@@ -1676 +1673 @@
             }
 
-        // For non-root activities, display a link to the replied-to activity's author's profile
+        // For non-root activities, display a link to the replied-to activity's author's profile.
         } else {
             echo '<strong>' . get_avatar( $this->get_activity_user_id( $item['item_id'] ), '32' ) . ' ' . bp_core_get_userlink( $this->get_activity_user_id( $item['item_id'] ) ) . '</strong><br />';
@@ -1695 +1692 @@
      * @param array  $item        Information about the current row.
      * @param string $column_name The column name.
-     *
      * @return string
      */
@@ -1721 +1717 @@
      *
      * @param int $activity_id Activity ID to retrieve User ID for.
-     *
      * @return int User ID of the activity item in question.
      */
@@ -1729 +1724 @@
             return $this->activity_user_id[$activity_id];
 
-        /**
+        /*
          * We don't have a mapping. This means the $activity_id is not on the current
          * page of results, so fetch its details from the database.
@@ -1736 +1731 @@
             $activity = bp_activity_get_specific( array( 'activity_ids' => $activity_id, 'show_hidden' => true, 'spam' => 'all', ) );
 
-            /**
+            /*
              * If, somehow, the referenced activity has been deleted, leaving its associated
              * activities as orphans, use the logged in user's ID to avoid errors.
@@ -1743 +1738 @@
                 return bp_loggedin_user_id();
 
-            // Store the new activity/user ID mapping for any later re-use
+            // Store the new activity/user ID mapping for any later re-use.
             $this->activity_user_id[ $activity['activities'][0]->id ] = $activity['activities'][0]->user_id;
 
-            // Return the user ID
+            // Return the user ID.
             return $activity['activities'][0]->user_id;
         }
@@ -1762 +1757 @@
      *
      * @param array $item An array version of the BP_Activity_Activity object.
-     *
-     * @return bool
+     * @return bool $can_comment
      */
     protected function can_comment( $item  ) {
@@ -1778 +1772 @@
             }
 
-        // activity comments supported
+        // Activity comments supported.
         } else {
-            // activity comment
+            // Activity comment.
             if ( 'activity_comment' == $item['type'] ) {
-                // blogs
+                // Blogs.
                 if ( bp_is_active( 'blogs' ) ) {
-                    // grab the parent activity entry
+                    // Grab the parent activity entry.
                     $parent_activity = new BP_Activity_Activity( $item['item_id'] );
 
-                    // fetch blog post comment depth and if the blog post's comments are open
+                    // Fetch blog post comment depth and if the blog post's comments are open.
                     bp_blogs_setup_activity_loop_globals( $parent_activity );
 
-                    // check if the activity item can be replied to
+                    // Check if the activity item can be replied to.
                     if ( false === bp_blogs_can_comment_reply( true, $item ) ) {
                         $can_comment = false;
@@ -1796 +1790 @@
                 }
 
-            // blog post
+            // Blog post.
             } elseif ( 'new_blog_post' == $item['type'] ) {
                 if ( bp_is_active( 'blogs' ) ) {
@@ -1827 +1821 @@
      *
      * @param array $tree Source array.
-     *
      * @return array Flattened array.
      */

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

@@ -3 +3 @@
  * Akismet support for BuddyPress' Activity Stream.
  *
- * @since 1.6.0
  * @package BuddyPress
  * @subpackage ActivityAkismet
+ * @since 1.6.0
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -18 +18 @@
  */
 class BP_Akismet {
+
     /**
      * The activity last marked as spam.
      *
+     * @since 1.6.0
+     *
      * @var BP_Activity_Activity
-     * @since 1.6.0
      */
     protected $last_activity = null;
@@ -41 +43 @@
      */
     protected function setup_actions() {
-        // Add nonces to activity stream lists
+        // Add nonces to activity stream lists.
         add_action( 'bp_after_activity_post_form', array( $this, 'add_activity_stream_nonce' ) );
         add_action( 'bp_activity_entry_comments',  array( $this, 'add_activity_stream_nonce' ) );
 
-        // Add a "mark as spam" button to individual activity items
+        // Add a "mark as spam" button to individual activity items.
         add_action( 'bp_activity_entry_meta',      array( $this, 'add_activity_spam_button' ) );
         add_action( 'bp_activity_comment_options', array( $this, 'add_activity_comment_spam_button' ) );
 
-        // Check activity for spam
+        // Check activity for spam.
         add_action( 'bp_activity_before_save',     array( $this, 'check_activity' ), 4, 1 );
 
-        // Tidy up member's latest (activity) update
+        // Tidy up member's latest (activity) update.
         add_action( 'bp_activity_posted_update',   array( $this, 'check_member_activity_update' ), 1, 3 );
 
-        // Hooks to extend Activity core spam/ham functions for Akismet
+        // Hooks to extend Activity core spam/ham functions for Akismet.
         add_action( 'bp_activity_mark_as_spam',    array( $this, 'mark_as_spam' ), 10, 2 );
         add_action( 'bp_activity_mark_as_ham',     array( $this, 'mark_as_ham' ),  10, 2 );
 
-        // Hook into the Activity wp-admin screen
+        // Hook into the Activity wp-admin screen.
         add_action( 'bp_activity_admin_comment_row_actions', array( $this, 'comment_row_action' ), 10, 2 );
         add_action( 'bp_activity_admin_load',                array( $this, 'add_history_metabox' ) );
@@ -74 +76 @@
      * @param array $actions  The hover links.
      * @param array $activity The activity for the current row being processed.
-     *
      * @return array The hover links.
      */
@@ -83 +84 @@
 
         if ( !$user_result || $user_result == $akismet_result ) {
-            // Show the original Akismet result if the user hasn't overridden it, or if their decision was the same
+            // Show the original Akismet result if the user hasn't overridden it, or if their decision was the same.
             if ( 'true' == $akismet_result && $activity['is_spam'] )
                 $desc = __( 'Flagged as spam by Akismet', 'buddypress' );
@@ -99 +100 @@
         }
 
-        // add a History item to the hover links, just after Edit
+        // Add a History item to the hover links, just after Edit.
         if ( $akismet_result ) {
             $b = array();
@@ -139 +140 @@
         $value   = '_bp_as_nonce_' . bp_loggedin_user_id();
 
-        // If we're in the activity stream loop, we can use the current item's ID to make the nonce unique
+        // If we're in the activity stream loop, we can use the current item's ID to make the nonce unique.
         if ( 'bp_activity_entry_comments' == current_filter() ) {
             $form_id .= '_' . bp_get_activity_id();
@@ -245 +246 @@
      * @static
      *
-     * @return array List of activity types.
+     * @return array $value List of activity types.
      */
     public static function get_activity_types() {
@@ -270 +271 @@
      */
     public function mark_as_spam( $activity, $source ) {
-        // Record this item so we can do some tidyup in BP_Akismet::check_member_activity_update()
+        // Record this item so we can do some tidyup in BP_Akismet::check_member_activity_update().
         $this->last_activity = $activity;
 
@@ -325 +326 @@
      *
      * @param BP_Activity_Activity $activity Activity item data.
-     *
-     * @return array
+     * @return array $activity_data
      */
     public static function build_akismet_data_package( $activity ) {
@@ -383 +383 @@
             return;
 
-        // Make sure last_activity is clear to avoid any confusion
+        // Make sure last_activity is clear to avoid any confusion.
         $this->last_activity = null;
 
-        // Build data package for Akismet
+        // Build data package for Akismet.
         $activity_data = BP_Akismet::build_akismet_data_package( $activity );
 
-        // Check with Akismet to see if this is spam
+        // Check with Akismet to see if this is spam.
         $activity_data = $this->send_akismet_request( $activity_data, 'check', 'spam' );
 
-        // Record this item
+        // Record this item.
         $this->last_activity = $activity;
 
-        // Store a copy of the data that was submitted to Akismet
+        // Store a copy of the data that was submitted to Akismet.
         $this->last_activity->akismet_submission = $activity_data;
 
-        // Spam
+        // Spam.
         if ( 'true' == $activity_data['bp_as_result'] ) {
             /**
@@ -411 +411 @@
             do_action_ref_array( 'bp_activity_akismet_spam_caught', array( &$activity, $activity_data ) );
 
-            // Mark as spam
+            // Mark as spam.
             bp_activity_mark_as_spam( $activity, 'by_akismet' );
         }
 
-        // Update activity meta after a spam check
+        // Update activity meta after a spam check.
         add_action( 'bp_activity_after_save', array( $this, 'update_activity_akismet_meta' ), 1, 1 );
     }
@@ -461 +461 @@
      */
     public function update_activity_akismet_meta( $activity ) {
-        // Check we're dealing with what was last updated by Akismet
+        // Check we're dealing with what was last updated by Akismet.
         if ( empty( $this->last_activity ) || !empty( $this->last_activity ) && $activity->id != $this->last_activity->id )
             return;
@@ -469 +469 @@
             return;
 
-        // Spam
+        // Spam.
         if ( 'true' == $this->last_activity->akismet_submission['bp_as_result'] ) {
             bp_activity_update_meta( $activity->id, '_bp_akismet_result', 'true' );
             $this->update_activity_history( $activity->id, __( 'Akismet caught this item as spam', 'buddypress' ), 'check-spam' );
 
-        // Not spam
+        // Not spam.
         } elseif ( 'false' == $this->last_activity->akismet_submission['bp_as_result'] ) {
             bp_activity_update_meta( $activity->id, '_bp_akismet_result', 'false' );
@@ -485 +485 @@
         }
 
-        // Record the original data which was submitted to Akismet for checking
+        // Record the original data which was submitted to Akismet for checking.
         bp_activity_update_meta( $activity->id, '_bp_akismet_submission', $this->last_activity->akismet_submission );
     }
@@ -499 +499 @@
      * @param string $check         "check" or "submit".
      * @param string $spam          "spam" or "ham".
-     *
      * @return array $activity_data Activity data, with Akismet data added.
      */
@@ -515 +514 @@
             $activity_data['is_test'] = 'true';
 
-        // Loop through _POST args and rekey strings
+        // Loop through _POST args and rekey strings.
         foreach ( $_POST as $key => $value )
             if ( is_string( $value ) && 'cookie' != $key )
                 $activity_data['POST_' . $key] = $value;
 
-        // Keys to ignore
+        // Keys to ignore.
         $ignore = array( 'HTTP_COOKIE', 'HTTP_COOKIE2', 'PHP_AUTH_PW' );
 
-        // Loop through _SERVER args and remove whitelisted keys
+        // Loop through _SERVER args and remove whitelisted keys.
         foreach ( $_SERVER as $key => $value ) {
 
-            // Key should not be ignored
+            // Key should not be ignored.
             if ( !in_array( $key, $ignore ) && is_string( $value ) ) {
                 $activity_data[$key] = $value;
 
-            // Key should be ignored
+            // Key should be ignored.
             } else {
                 $activity_data[$key] = '';
@@ -544 +543 @@
             $path = 'submit-' . $spam;
 
-        // Send to Akismet
+        // Send to Akismet.
         add_filter( 'akismet_ua', array( $this, 'buddypress_ua' ) );
         $response = Akismet::http_post( $query_string, $path );
         remove_filter( 'akismet_ua', array( $this, 'buddypress_ua' ) );
 
-        // Get the response
+        // Get the response.
         if ( ! empty( $response[1] ) && ! is_wp_error( $response[1] ) )
             $activity_data['bp_as_result'] = $response[1];
@@ -555 +554 @@
             $activity_data['bp_as_result'] = false;
 
-        // Perform a daily tidy up
+        // Perform a daily tidy up.
         if ( ! wp_next_scheduled( 'bp_activity_akismet_delete_old_metadata' ) )
             wp_schedule_event( time(), 'daily', 'bp_activity_akismet_delete_old_metadata' );
@@ -568 +567 @@
      *
      * @param string $user_agent User agent string, as generated by Akismet.
-     *
      * @return string $user_agent Modified user agent string.
      */
@@ -584 +582 @@
      */
     function add_history_metabox( $screen_action ) {
-        // Only proceed if we're on the edit screen
+        // Only proceed if we're on the edit screen.
         if ( 'edit' != $screen_action )
             return;
 
-        // Display meta box with a low priority (low position on screen by default)
+        // Display meta box with a low priority (low position on screen by default).
         add_meta_box( 'bp_activity_history',  __( 'Activity History', 'buddypress' ), array( $this, 'history_metabox' ), get_current_screen()->id, 'normal', 'low' );
     }
@@ -630 +628 @@
         );
 
-        // Save the history data
+        // Save the history data.
         bp_activity_update_meta( $activity_id, '_bp_akismet_history', $event );
     }
@@ -640 +638 @@
      *
      * @param int $activity_id Activity item ID.
-     *
      * @return array The activity item's Akismet history.
      */
@@ -648 +645 @@
             $history = array();
 
-        // Sort it by the time recorded
+        // Sort it by the time recorded.
         usort( $history, 'akismet_cmp_time' );
 
@@ -679 +676 @@
     $interval = apply_filters( 'bp_activity_akismet_delete_meta_interval', 15 );
 
-    // Enforce a minimum of 1 day
+    // Enforce a minimum of 1 day.
     $interval = max( 1, absint( $interval ) );
 

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

@@ -8 +8 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -19 +19 @@
  *
  * @param int|string|array|bool $activity_ids Accepts a single activity ID, or a comma-
- *                                            separated list or array of activity ids
+ *                                            separated list or array of activity ids.
  */
 function bp_activity_update_meta_cache( $activity_ids = false ) {
@@ -41 +41 @@
  * @since 2.0.0
  *
- * @param BP_Activity_Activity $activity
+ * @param BP_Activity_Activity $activity Activity object.
  */
 function bp_activity_clear_cache_for_activity( $activity ) {

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

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Activity Classes
+ * BuddyPress Activity Classes.
  *
  * @package BuddyPress
@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -20 +20 @@
     }
 
-    // Special handling for New/Edit screens in wp-admin
+    // Special handling for New/Edit screens in wp-admin.
     if ( is_admin() ) {
         if (
@@ -64 +64 @@
  * @param array  $settings   An array with TinyMCE config.
  * @param string $editor_id Unique editor identifier, e.g. 'content'.
- *
  * @return array  $mceInit   An array with TinyMCE config.
  */

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
 /** Filters *******************************************************************/
 
-// Apply WordPress defined filters
+// Apply WordPress defined filters.
 add_filter( 'bp_get_activity_action',                'bp_activity_filter_kses', 1 );
 add_filter( 'bp_get_activity_content_body',          'bp_activity_filter_kses', 1 );
@@ -78 +78 @@
 add_filter( 'bp_activity_primary_link_before_save',  'esc_url_raw' );
 
-// Apply BuddyPress-defined filters
+// Apply BuddyPress-defined filters.
 add_filter( 'bp_get_activity_content',               'bp_activity_make_nofollow_filter' );
 add_filter( 'bp_get_activity_content_body',          'bp_activity_make_nofollow_filter' );
@@ -101 +101 @@
 /** Actions *******************************************************************/
 
-// At-name filter
+// At-name filter.
 add_action( 'bp_activity_before_save', 'bp_activity_at_name_filter_updates' );
 
-// Activity stream moderation
+// Activity stream moderation.
 add_action( 'bp_activity_before_save', 'bp_activity_check_moderation_keys', 2, 1 );
 add_action( 'bp_activity_before_save', 'bp_activity_check_blacklist_keys',  2, 1 );
@@ -142 +142 @@
 function bp_activity_check_moderation_keys( $activity ) {
 
-    // Only check specific types of activity updates
+    // Only check specific types of activity updates.
     if ( !in_array( $activity->type, bp_activity_get_moderated_activity_types() ) )
         return;
 
     // Unset the activity component so activity stream update fails
-    // @todo This is temporary until some kind of moderation is built
+    // @todo This is temporary until some kind of moderation is built.
     if ( !bp_core_check_for_moderation( $activity->user_id, '', $activity->content ) )
         $activity->component = false;
@@ -161 +161 @@
 function bp_activity_check_blacklist_keys( $activity ) {
 
-    // Only check specific types of activity updates
+    // Only check specific types of activity updates.
     if ( ! in_array( $activity->type, bp_activity_get_moderated_activity_types() ) )
         return;
 
-    // Mark as spam
+    // Mark as spam.
     if ( ! bp_core_check_for_blacklist( $activity->user_id, '', $activity->content ) )
         bp_activity_mark_as_spam( $activity, 'by_blacklist' );
@@ -179 +179 @@
  *
  * @param string $content The activity content.
- *
  * @return string $content Filtered activity content.
  */
@@ -223 +222 @@
  * @param string $content     The contents of a given item.
  * @param int    $activity_id The activity id. Deprecated.
- *
  * @return string $content Content filtered for mentions.
  */
@@ -233 +231 @@
     }
 
-    // Try to find mentions
+    // Try to find mentions.
     $usernames = bp_activity_find_mentions( $content );
 
@@ -241 +239 @@
 
     // We don't want to link @mentions that are inside of links, so we
-    // temporarily remove them
+    // temporarily remove them.
     $replace_count = 0;
     $replacements = array();
     foreach ( $usernames as $username ) {
-        // prevent @ name linking inside <a> tags
+        // Prevent @ name linking inside <a> tags.
         preg_match_all( '/(<a.*?(?!<\/a>)@' . $username . '.*?<\/a>)/', $content, $content_matches );
         if ( ! empty( $content_matches[1] ) ) {
@@ -256 +254 @@
     }
 
-    // Linkify the mentions with the username
+    // Linkify the mentions with the username.
     foreach ( (array) $usernames as $user_id => $username ) {
         $content = preg_replace( '/(@' . $username . '\b)/', "<a href='" . bp_core_get_user_domain( $user_id ) . "' rel='nofollow'>@$username</a>", $content );
     }
 
-    // put everything back
+    // Put everything back.
     if ( ! empty( $replacements ) ) {
         foreach ( $replacements as $placeholder => $original ) {
@@ -268 +266 @@
     }
 
-    // Return the content
+    // Return the content.
     return $content;
 }
@@ -282 +280 @@
  * @uses bp_activity_find_mentions()
  *
- * @param BP_Activity_Activity $activity
+ * @param BP_Activity_Activity $activity Activity Object.
  */
 function bp_activity_at_name_filter_updates( $activity ) {
@@ -294 +292 @@
         return;
 
-    // Try to find mentions
+    // Try to find mentions.
     $usernames = bp_activity_find_mentions( $activity->content );
 
     // We have mentions!
     if ( ! empty( $usernames ) ) {
-        // Replace @mention text with userlinks
+        // Replace @mention text with userlinks.
         foreach( (array) $usernames as $user_id => $username ) {
             $activity->content = preg_replace( '/(@' . $username . '\b)/', "<a href='" . bp_core_get_user_domain( $user_id ) . "' rel='nofollow'>@$username</a>", $activity->content );
         }
 
-        // Add our hook to send @mention emails after the activity item is saved
+        // Add our hook to send @mention emails after the activity item is saved.
         add_action( 'bp_activity_after_save', 'bp_activity_at_name_send_emails' );
 
-        // temporary variable to avoid having to run bp_activity_find_mentions() again
+        // Temporary variable to avoid having to run bp_activity_find_mentions() again.
         buddypress()->activity->mentioned_users = $usernames;
     }
@@ -332 +330 @@
         return;
 
-    // Grab our temporary variable from bp_activity_at_name_filter_updates()
+    // Grab our temporary variable from bp_activity_at_name_filter_updates().
     $usernames = buddypress()->activity->mentioned_users;
 
-    // Get rid of temporary variable
+    // Get rid of temporary variable.
     unset( buddypress()->activity->mentioned_users );
 
-    // Send @mentions and setup BP notifications
+    // Send @mentions and setup BP notifications.
     foreach( (array) $usernames as $user_id => $username ) {
 
@@ -353 +351 @@
         }
 
-        // Updates mention count for the user
+        // Updates mention count for the user.
         bp_activity_update_mention_count_for_user( $user_id, $activity->id );
     }
@@ -364 +362 @@
  *
  * @param string $text Activity text.
- *
  * @return string $text Text with rel=nofollow added to any links.
  */
@@ -377 +374 @@
      *
      * @param array $matches Items matched by preg_replace_callback() in bp_activity_make_nofollow_filter().
-     *
      * @return string $text Link with rel=nofollow added.
      */
@@ -402 +398 @@
  *
  * @param string $text The original activity entry text.
- *
  * @return string $excerpt The truncated text.
  */
@@ -420 +415 @@
     );
 
-    // The full text of the activity update should always show on the single activity screen
+    // The full text of the activity update should always show on the single activity screen.
     if ( ! $maybe_truncate_text || bp_is_single_activity() ) {
         return $text;
@@ -443 +438 @@
     $excerpt_length = apply_filters( 'bp_activity_excerpt_length', 358 );
 
-    // Run the text through the excerpt function. If it's too short, the original text will be
-    // returned.
+    // Run the text through the excerpt function. If it's too short, the original text will be returned.
     $excerpt        = bp_create_excerpt( $text, $excerpt_length, array( 'ending' => __( '&hellip;', 'buddypress' ) ) );
 
-    // If the text returned by bp_create_excerpt() is different from the original text (ie it's
-    // been truncated), add the "Read More" link. Note that bp_create_excerpt() is stripping
-    // shortcodes, so we have strip them from the $text before the comparison
+    /*
+     * If the text returned by bp_create_excerpt() is different from the original text (ie it's
+     * been truncated), add the "Read More" link. Note that bp_create_excerpt() is stripping
+     * shortcodes, so we have strip them from the $text before the comparison.
+     */
     if ( $excerpt != strip_shortcodes( $text ) ) {
         $id = !empty( $activities_template->activity->current_comment->id ) ? 'acomment-read-more-' . $activities_template->activity->current_comment->id : 'activity-read-more-' . bp_get_activity_id();
@@ -476 +472 @@
  *
  * @param array $js_handles The original dependencies.
- *
  * @return array $js_handles The new dependencies.
  */
@@ -496 +491 @@
  * @since 2.0.0
  *
- * @param string $classes
- *
+ * @param string $classes Array of classes for most recent activity item.
  * @return string $classes
  */
@@ -516 +510 @@
  * @since 2.0.0
  *
- * @param string $classes
- *
+ * @param string $classes Array of classes for timestamp.
  * @return string $classes
  */
@@ -545 +538 @@
  * @uses bp_activity_get_last_updated() to get the recorded date of the last activity.
  *
- * @param array $response
- * @param array $data
- *
+ * @param array $response Array containing Heartbeat API response.
+ * @param array $data     Array containing data for Heartbeat API response.
  * @return array $response
  */
@@ -556 +548 @@
 
     // Use the querystring argument stored in the cookie (to preserve
-    // filters), but force the offset to get only new items
+    // filters), but force the offset to get only new items.
     $activity_latest_args = bp_parse_args(
         bp_ajax_querystring( 'activity' ),
@@ -570 +562 @@
     $last_activity_recorded = 0;
 
-    // Temporarily add a just-posted class for new activity items
+    // Temporarily add a just-posted class for new activity items.
     add_filter( 'bp_get_activity_css_class', 'bp_activity_newest_class', 10, 1 );
 
@@ -591 +583 @@
     ob_end_clean();
 
-    // Remove the temporary filter
+    // Remove the temporary filter.
     remove_filter( 'bp_get_activity_css_class', 'bp_activity_newest_class', 10, 1 );
 
@@ -609 +601 @@
  *
  * @param array $strings Localized strings.
- *
  * @return array $strings
  */
@@ -672 +663 @@
  * @param array $retval Empty array by default.
  * @param array $filter Current activity arguments.
- *
- * @return array
+ * @return array $retval
  */
 function bp_activity_filter_just_me_scope( $retval = array(), $filter = array() ) {
 
-    // Determine the user_id
+    // Determine the user_id.
     if ( ! empty( $filter['user_id'] ) ) {
         $user_id = $filter['user_id'];
@@ -703 +693 @@
         $show_hidden,
 
-        // overrides
+        // Overrides.
         'override' => array(
             'display_comments' => 'stream',
@@ -722 +712 @@
  * @param array $retval Empty array by default.
  * @param array $filter Current activity arguments.
- *
- * @return array
+ * @return array $retval
  */
 function bp_activity_filter_favorites_scope( $retval = array(), $filter = array() ) {
 
-    // Determine the user_id
+    // Determine the user_id.
     if ( ! empty( $filter['user_id'] ) ) {
         $user_id = $filter['user_id'];
@@ -736 +725 @@
     }
 
-    // Determine the favorites
+    // Determine the favorites.
     $favs = bp_activity_get_user_favorites( $user_id );
     if ( empty( $favs ) ) {
@@ -760 +749 @@
         $show_hidden,
 
-        // overrides
+        // Overrides.
         'override' => array(
             'display_comments' => true,
@@ -780 +769 @@
  * @param array $retval Empty array by default.
  * @param array $filter Current activity arguments.
- *
- * @return array
+ * @return array $retval
  */
 function bp_activity_filter_mentions_scope( $retval = array(), $filter = array() ) {
@@ -790 +778 @@
     }
 
-    // Determine the user_id
+    // Determine the user_id.
     if ( ! empty( $filter['user_id'] ) ) {
         $user_id = $filter['user_id'];
@@ -819 +807 @@
         $show_hidden,
 
-        // overrides
+        // Overrides.
         'override' => array(
 
-            // clear search terms so 'mentions' scope works with other scopes
+            // Clear search terms so 'mentions' scope works with other scopes.
             'search_terms' => false,
 

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

@@ -9 +9 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -86 +86 @@
  * @param string $content The content of the activity, usually found in
  *                        $activity->content.
- *
  * @return array|bool Associative array with user ID as key and username as
  *                    value. Boolean false if no mentions found.
@@ -95 +94 @@
     preg_match_all( $pattern, $content, $usernames );
 
-    // Make sure there's only one instance of each username
+    // Make sure there's only one instance of each username.
     $usernames = array_unique( $usernames[1] );
 
-    // Bail if no usernames
+    // Bail if no usernames.
     if ( empty( $usernames ) ) {
         return false;
@@ -105 +104 @@
     $mentioned_users = array();
 
-    // We've found some mentions! Check to see if users exist
+    // We've found some mentions! Check to see if users exist.
     foreach( (array) array_values( $usernames ) as $username ) {
         $user_id = bp_activity_get_userid_from_mentionname( $username );
 
-        // user ID exists, so let's add it to our array
+        // The user ID exists, so let's add it to our array.
         if ( ! empty( $user_id ) ) {
             $mentioned_users[ $user_id ] = $username;
@@ -151 +150 @@
  * @param int    $activity_id The unique id for the activity item.
  * @param string $action      Can be 'delete' or 'add'. Defaults to 'add'.
- *
  * @return bool
  */
 function bp_activity_adjust_mention_count( $activity_id = 0, $action = 'add' ) {
 
-    // Bail if no activity ID passed
+    // Bail if no activity ID passed.
     if ( empty( $activity_id ) ) {
         return false;
     }
 
-    // Get activity object
+    // Get activity object.
     $activity  = new BP_Activity_Activity( (int) $activity_id );
 
-    // Try to find mentions
+    // Try to find mentions.
     $usernames = bp_activity_find_mentions( strip_tags( $activity->content ) );
 
-    // Still empty? Stop now
+    // Still empty? Stop now.
     if ( empty( $usernames ) ) {
         return false;
     }
 
-    // Increment mention count foreach mentioned user
+    // Increment mention count foreach mentioned user.
     foreach( (array) array_keys( $usernames ) as $user_id ) {
         bp_activity_update_mention_count_for_user( $user_id, $activity_id, $action );
@@ -192 +190 @@
  * @param int    $activity_id The unique ID for the activity item.
  * @param string $action      'delete' or 'add'. Default: 'add'.
- *
  * @return bool
  */
@@ -201 +198 @@
     }
 
-    // Adjust the mention list and count for the member
+    // Adjust the mention list and count for the member.
     $new_mention_count = (int) bp_get_user_meta( $user_id, 'bp_new_mention_count', true );
     $new_mentions      =       bp_get_user_meta( $user_id, 'bp_new_mentions',      true );
 
-    // Make sure new mentions is an array
+    // Make sure new mentions is an array.
     if ( empty( $new_mentions ) ) {
         $new_mentions = array();
@@ -229 +226 @@
     }
 
-    // Get an updated mention count
+    // Get an updated mention count.
     $new_mention_count = count( $new_mentions );
 
-    // Resave the user_meta
+    // Resave the user_meta.
     bp_update_user_meta( $user_id, 'bp_new_mention_count', $new_mention_count );
     bp_update_user_meta( $user_id, 'bp_new_mentions',      $new_mentions );
@@ -245 +242 @@
  *
  * @param int|string $user_id ID of the user to get @-mention name for.
- *
- * @return string User name appropriate for @-mentions.
+ * @return string $mentionname User name appropriate for @-mentions.
  */
 function bp_activity_get_user_mentionname( $user_id ) {
@@ -270 +266 @@
  *
  * @param string $mentionname Username of user in @-mentions.
- *
  * @return int|bool ID of the user, if one is found. Otherwise false.
  */
@@ -276 +271 @@
     $user_id = false;
 
-    // In username compatibility mode, hyphens are ambiguous between
-    // actual hyphens and converted spaces.
-    //
-    // @todo There is the potential for username clashes between 'foo bar'
-    // and 'foo-bar' in compatibility mode. Come up with a system for
-    // unique mentionnames.
+    /*
+     * In username compatibility mode, hyphens are ambiguous between
+     * actual hyphens and converted spaces.
+     *
+     * @todo There is the potential for username clashes between 'foo bar'
+     * and 'foo-bar' in compatibility mode. Come up with a system for
+     * unique mentionnames.
+     */
     if ( bp_is_username_compatibility_mode() ) {
-        // First, try the raw username
+        // First, try the raw username.
         $userdata = get_user_by( 'login', $mentionname );
 
@@ -297 +294 @@
 
     // When username compatibility mode is disabled, the mentionname is
-    // the same as the nicename
+    // the same as the nicename.
     } else {
         $user_id = bp_core_get_userid_from_nicename( $mentionname );
@@ -332 +329 @@
  *                                        Values: 'activity', 'member', 'member_groups', 'group'.
  * @param  int           $position        Optional. The position of the action when listed in dropdowns.
- *
  * @return bool False if any param is empty, otherwise true.
  */
@@ -338 +334 @@
     $bp = buddypress();
 
-    // Return false if any of the above values are not set
+    // Return false if any of the above values are not set.
     if ( empty( $component_id ) || empty( $type ) || empty( $description ) ) {
         return false;
     }
 
-    // Set activity action
+    // Set activity action.
     if ( ! isset( $bp->activity->actions ) || ! is_object( $bp->activity->actions ) ) {
         $bp->activity->actions = new stdClass;
     }
 
-    // Verify callback
+    // Verify callback.
     if ( ! is_callable( $format_callback ) ) {
         $format_callback = '';
@@ -393 +389 @@
  * @param array  $args {
  *     An associative array of tracking parameters. All items are optional.
- *
  *     @type string   $bp_activity_admin_filter String to use in the Dashboard > Activity dropdown.
  *     @type string   $bp_activity_front_filter String to use in frontend dropdown.
@@ -415 +410 @@
  *                                              the post type does not natively support comments, otherwise false.
  * }
- *
  * @return bool
  */
@@ -445 +439 @@
  *
  * @param  string $post_type Name of the post type.
- *
  * @return object The tracking arguments of the post type.
  */
@@ -515 +508 @@
  */
 function bp_activity_get_post_types_tracking_args() {
-    // Fetch all public post types
+    // Fetch all public post types.
     $post_types = get_post_types( array( 'public' => true ), 'names' );
 
@@ -595 +588 @@
  * @param string $component_id The unique string ID of the component.
  * @param string $key          The action key.
- *
  * @return string|bool Action value if found, otherwise false.
  */
 function bp_activity_get_action( $component_id, $key ) {
 
-    // Return false if any of the above values are not set
+    // Return false if any of the above values are not set.
     if ( empty( $component_id ) || empty( $key ) ) {
         return false;
@@ -643 +635 @@
     }
 
-    // This was a mis-named activity type from before BP 1.6
+    // This was a mis-named activity type from before BP 1.6.
     unset( $actions['friends_register_activity_action'] );
 
@@ -667 +659 @@
  *
  * @param int $user_id ID of the user whose favorites are being queried.
- *
  * @return array IDs of the user's favorite activity items.
  */
 function bp_activity_get_user_favorites( $user_id = 0 ) {
 
-    // Fallback to logged in user if no user_id is passed
+    // Fallback to logged in user if no user_id is passed.
     if ( empty( $user_id ) ) {
         $user_id = bp_displayed_user_id();
     }
 
-    // Get favorites for user
+    // Get favorites for user.
     $favs = bp_get_user_meta( $user_id, 'bp_favorite_activities', true );
 
@@ -705 +696 @@
  * @param int $activity_id ID of the activity item being favorited.
  * @param int $user_id     ID of the user favoriting the activity item.
- *
  * @return bool True on success, false on failure.
  */
 function bp_activity_add_user_favorite( $activity_id, $user_id = 0 ) {
 
-    // Favorite activity stream items are for logged in users only
+    // Favorite activity stream items are for logged in users only.
     if ( ! is_user_logged_in() ) {
         return false;
     }
 
-    // Fallback to logged in user if no user_id is passed
+    // Fallback to logged in user if no user_id is passed.
     if ( empty( $user_id ) ) {
         $user_id = bp_loggedin_user_id();
@@ -725 +715 @@
     }
 
-    // Bail if the user has already favorited this activity item
+    // Bail if the user has already favorited this activity item.
     if ( in_array( $activity_id, $my_favs ) ) {
         return false;
     }
 
-    // Add to user's favorites
+    // Add to user's favorites.
     $my_favs[] = $activity_id;
 
-    // Update the total number of users who have favorited this activity
+    // Update the total number of users who have favorited this activity.
     $fav_count = bp_activity_get_meta( $activity_id, 'favorite_count' );
     $fav_count = !empty( $fav_count ) ? (int) $fav_count + 1 : 1;
 
-    // Update user meta
+    // Update user meta.
     bp_update_user_meta( $user_id, 'bp_favorite_activities', $my_favs );
 
-    // Update activity meta counts
+    // Update activity meta counts.
     if ( bp_activity_update_meta( $activity_id, 'favorite_count', $fav_count ) ) {
 
@@ -753 +743 @@
         do_action( 'bp_activity_add_user_favorite', $activity_id, $user_id );
 
-        // Success
+        // Success.
         return true;
 
-    // Saving meta was unsuccessful for an unknown reason
+    // Saving meta was unsuccessful for an unknown reason.
     } else {
 
@@ -787 +777 @@
  * @param int $activity_id ID of the activity item being unfavorited.
  * @param int $user_id     ID of the user unfavoriting the activity item.
- *
  * @return bool True on success, false on failure.
  */
 function bp_activity_remove_user_favorite( $activity_id, $user_id = 0 ) {
 
-    // Favorite activity stream items are for logged in users only
+    // Favorite activity stream items are for logged in users only.
     if ( ! is_user_logged_in() ) {
         return false;
     }
 
-    // Fallback to logged in user if no user_id is passed
+    // Fallback to logged in user if no user_id is passed.
     if ( empty( $user_id ) ) {
         $user_id = bp_loggedin_user_id();
@@ -805 +794 @@
     $my_favs = array_flip( (array) $my_favs );
 
-    // Bail if the user has not previously favorited the item
+    // Bail if the user has not previously favorited the item.
     if ( ! isset( $my_favs[ $activity_id ] ) ) {
         return false;
     }
 
-    // Remove the fav from the user's favs
+    // Remove the fav from the user's favs.
     unset( $my_favs[$activity_id] );
     $my_favs = array_unique( array_flip( $my_favs ) );
 
-    // Update the total number of users who have favorited this activity
+    // Update the total number of users who have favorited this activity.
     $fav_count = bp_activity_get_meta( $activity_id, 'favorite_count' );
     if ( ! empty( $fav_count ) ) {
 
-        // Deduct from total favorites
+        // Deduct from total favorites.
         if ( bp_activity_update_meta( $activity_id, 'favorite_count', (int) $fav_count - 1 ) ) {
 
-            // Update users favorites
+            // Update users favorites.
             if ( bp_update_user_meta( $user_id, 'bp_favorite_activities', $my_favs ) ) {
 
@@ -834 +823 @@
                 do_action( 'bp_activity_remove_user_favorite', $activity_id, $user_id );
 
-                // Success
+                // Success.
                 return true;
 
-            // Error updating
+            // Error updating.
             } else {
                 return false;
             }
 
-        // Error updating favorite count
+        // Error updating favorite count.
         } else {
             return false;
         }
 
-    // Error getting favorite count
+    // Error getting favorite count.
     } else {
         return false;
@@ -862 +851 @@
  *
  * @param string $content The content to filter by.
- *
  * @return int|null The ID of the located activity item. Null if none is found.
  */
@@ -907 +895 @@
  *
  * @param int $user_id ID of the user whose favorite count is being requested.
- *
  * @return int Total favorite count for the user.
  */
 function bp_activity_total_favorites_for_user( $user_id = 0 ) {
 
-    // Fallback on displayed user, and then logged in user
+    // Fallback on displayed user, and then logged in user.
     if ( empty( $user_id ) ) {
         $user_id = ( bp_displayed_user_id() ) ? bp_displayed_user_id() : bp_loggedin_user_id();
@@ -937 +924 @@
  * @param bool   $delete_all  Optional. If true, delete matching metadata entries
  *                            for all objects, ignoring the specified object_id. Otherwise,
- *                            only delete matching metadata entries for the specified
- *                            activity item. Default: false.
- *
+ *                            only delete matching metadata entries for the specified
+ *                            activity item. Default: false.
  * @return bool True on success, false on failure.
  */
 function bp_activity_delete_meta( $activity_id, $meta_key = '', $meta_value = '', $delete_all = false ) {
 
-    // Legacy - if no meta_key is passed, delete all for the item
+    // Legacy - if no meta_key is passed, delete all for the item.
     if ( empty( $meta_key ) ) {
         $all_meta = bp_activity_get_meta( $activity_id );
         $keys     = ! empty( $all_meta ) ? array_keys( $all_meta ) : array();
 
-        // With no meta_key, ignore $delete_all
+        // With no meta_key, ignore $delete_all.
         $delete_all = false;
     } else {
@@ -978 +964 @@
  *                            activity item will be fetched.
  * @param bool   $single      Optional. If true, return only the first value of the
- *                            specified meta_key. This parameter has no effect if meta_key is not
- *                            specified. Default: true.
- *
+ *                            specified meta_key. This parameter has no effect if meta_key is not
+ *                            specified. Default: true.
  * @return mixed The meta value(s) being requested.
  */
@@ -1011 +996 @@
  * @param mixed  $prev_value  Optional. If specified, only update existing metadata entries
  *                            with the specified value. Otherwise, update all entries.
- *
  * @return bool|int Returns false on failure. On successful update of existing
  *                  metadata, returns true. On successful creation of new metadata,
@@ -1035 +1019 @@
  *                            given key. If true, and the object already has a value for
  *                            the key, no change will be made. Default: false.
- *
  * @return int|bool The meta ID on successful update, false on failure.
  */
@@ -1060 +1043 @@
  *
  * @param int $user_id ID of the user whose activity is being deleted.
- *
  * @return bool
  */
 function bp_activity_remove_all_user_data( $user_id = 0 ) {
 
-    // Do not delete user data unless a logged in user says so
+    // Do not delete user data unless a logged in user says so.
     if ( empty( $user_id ) || ! is_user_logged_in() ) {
         return false;
     }
 
-    // Clear the user's activity from the sitewide stream and clear their activity tables
+    // Clear the user's activity from the sitewide stream and clear their activity tables.
     bp_activity_delete( array( 'user_id' => $user_id ) );
 
-    // Remove any usermeta
+    // Remove any usermeta.
     bp_delete_user_meta( $user_id, 'bp_latest_update'       );
     bp_delete_user_meta( $user_id, 'bp_favorite_activities' );
@@ -1100 +1082 @@
  *
  * @param int $user_id ID of the user whose activity is being spammed.
- *
  * @return bool
  */
@@ -1106 +1087 @@
     global $wpdb;
 
-    // Do not delete user data unless a logged in user says so
+    // Do not delete user data unless a logged in user says so.
     if ( empty( $user_id ) || ! is_user_logged_in() ) {
         return false;
@@ -1120 +1101 @@
     $bp = buddypress();
 
-    // Mark each as spam
+    // Mark each as spam.
     foreach ( (array) $activities['activities'] as $activity ) {
 
-        // Create an activity object
+        // Create an activity object.
         $activity_obj = new BP_Activity_Activity;
         foreach ( $activity as $k => $v ) {
@@ -1129 +1110 @@
         }
 
-        // Mark as spam
+        // Mark as spam.
         bp_activity_mark_as_spam( $activity_obj );
 
@@ -1143 +1124 @@
         }
 
-        // Tidy up
+        // Tidy up.
         unset( $activity_obj );
     }
 
-    // Mark all of this user's activities as spam
+    // Mark all of this user's activities as spam.
     $wpdb->query( $wpdb->prepare( "UPDATE {$bp->activity->table_name} SET is_spam = 1 WHERE user_id = %d", $user_id ) );
 
@@ -1170 +1151 @@
  *
  * @param int $user_id ID of the user whose activity is being hammed.
- *
  * @return bool
  */
@@ -1176 +1156 @@
     global $wpdb;
 
-    // Do not delete user data unless a logged in user says so
+    // Do not delete user data unless a logged in user says so.
     if ( empty( $user_id ) || ! is_user_logged_in() ) {
         return false;
@@ -1191 +1171 @@
     $bp = buddypress();
 
-    // Mark each as not spam
+    // Mark each as not spam.
     foreach ( (array) $activities['activities'] as $activity ) {
 
-        // Create an activity object
+        // Create an activity object.
         $activity_obj = new BP_Activity_Activity;
         foreach ( $activity as $k => $v ) {
@@ -1200 +1180 @@
         }
 
-        // Mark as not spam
+        // Mark as not spam.
         bp_activity_mark_as_ham( $activity_obj );
 
@@ -1214 +1194 @@
         }
 
-        // Tidy up
+        // Tidy up.
         unset( $activity_obj );
     }
 
-    // Mark all of this user's activities as not spam
+    // Mark all of this user's activities as not spam.
     $wpdb->query( $wpdb->prepare( "UPDATE {$bp->activity->table_name} SET is_spam = 0 WHERE user_id = %d", $user_id ) );
 
@@ -1276 +1256 @@
  *
  * @param object $activity Activity data object.
- *
  * @return string|bool Returns false if no callback is found, otherwise returns
  *                     the formatted action string.
@@ -1282 +1261 @@
 function bp_activity_generate_action_string( $activity ) {
 
-    // Check for valid input
+    // Check for valid input.
     if ( empty( $activity->component ) || empty( $activity->type ) ) {
         return false;
     }
 
-    // Check for registered format callback
+    // Check for registered format callback.
     $actions = bp_activity_get_actions();
     if ( empty( $actions->{$activity->component}->{$activity->type}['format_callback'] ) ) {
@@ -1293 +1272 @@
     }
 
-    // We apply the format_callback as a filter
+    // We apply the format_callback as a filter.
     add_filter( 'bp_activity_generate_action_string', $actions->{$activity->component}->{$activity->type}['format_callback'], 10, 2 );
 
@@ -1306 +1285 @@
     $action = apply_filters( 'bp_activity_generate_action_string', $activity->action, $activity );
 
-    // Remove the filter for future activity items
+    // Remove the filter for future activity items.
     remove_filter( 'bp_activity_generate_action_string', $actions->{$activity->component}->{$activity->type}['format_callback'], 10, 2 );
 
@@ -1319 +1298 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity data object.
- *
- * @return string
+ * @return string $action
  */
 function bp_activity_format_activity_action_activity_update( $action, $activity ) {
@@ -1343 +1321 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity data object.
- *
- * @return string
+ * @return string $action
  */
 function bp_activity_format_activity_action_activity_comment( $action, $activity ) {
@@ -1367 +1344 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity data object.
- *
- * @return string
+ * @return string $action
  */
 function bp_activity_format_activity_action_custom_post_type_post( $action, $activity ) {
@@ -1418 +1394 @@
 }
 
-/******************************************************************************
+/*
  * Business functions are where all the magic happens in BuddyPress. They will
  * handle the actual saving or manipulation of information. Usually they will
@@ -1428 +1404 @@
  * Retrieve an activity or activities.
  *
- * bp_activity_get() shares all arguments with BP_Activity_Activity::get(). The
- * following is a list of bp_activity_get() parameters that have different
+ * The bp_activity_get() function shares all arguments with BP_Activity_Activity::get().
+ * The following is a list of bp_activity_get() parameters that have different
  * default values from BP_Activity_Activity::get() (value in parentheses is
  * the default for the bp_activity_get()).
@@ -1446 +1422 @@
  *
  * @param array|string $args See BP_Activity_Activity::get() for description.
- *
  * @return array $activity See BP_Activity_Activity::get() for description.
  */
@@ -1464 +1439 @@
         'filter_query'      => false,
         'show_hidden'       => false,        // Show activity items that are hidden site-wide?
-        'exclude'           => false,        // Comma-separated list of activity IDs to exclude
-        'in'                => false,        // Comma-separated list or array of activity IDs to which you want to limit the query
+        'exclude'           => false,        // Comma-separated list of activity IDs to exclude.
+        'in'                => false,        // Comma-separated list or array of activity IDs to which you
+                                             // want to limit the query.
         'spam'              => 'ham_only',   // 'ham_only' (default), 'spam_only' or 'all'.
         'update_meta_cache' => true,
@@ -1474 +1450 @@
          * Pass filters as an array -- all filter items can be multiple values comma separated:
          * array(
-         *  'user_id'      => false, // user_id to filter on
-         *  'object'       => false, // object to filter on e.g. groups, profile, status, friends
-         *  'action'       => false, // action to filter on e.g. activity_update, profile_updated
-         *  'primary_id'   => false, // object ID to filter on e.g. a group_id or forum_id or blog_id etc.
-         *  'secondary_id' => false, // secondary object ID to filter on e.g. a post_id
+         *     'user_id'      => false, // User ID to filter on.
+         *     'object'       => false, // Object to filter on e.g. groups, profile, status, friends.
+         *     'action'       => false, // Action to filter on e.g. activity_update, profile_updated.
+         *     'primary_id'   => false, // Object ID to filter on e.g. a group_id or forum_id or blog_id etc.
+         *     'secondary_id' => false, // Secondary object ID to filter on e.g. a post_id.
          * );
          */
@@ -1558 +1534 @@
  *     except for the following:
  *     @type string|int|array Single activity ID, comma-separated list of IDs,
- *           or array of IDs.
+ *                            or array of IDs.
  * }
  * @return array $activity See BP_Activity_Activity::get() for description.
@@ -1566 +1542 @@
     $r = bp_parse_args( $args, array(
         'activity_ids'      => false,      // A single activity_id or array of IDs.
-        'display_comments'  => false,      // true or false to display threaded comments for these specific activity items
-        'max'               => false,      // Maximum number of results to return
-        'page'              => 1,          // page 1 without a per_page will result in no pagination.
-        'per_page'          => false,      // results per page
-        'show_hidden'       => true,       // When fetching specific items, show all
-        'sort'              => 'DESC',     // sort ASC or DESC
-        'spam'              => 'ham_only', // Retrieve items marked as spam
+        'display_comments'  => false,      // True or false to display threaded comments for these specific activity items.
+        'max'               => false,      // Maximum number of results to return.
+        'page'              => 1,          // Page 1 without a per_page will result in no pagination.
+        'per_page'          => false,      // Results per page.
+        'show_hidden'       => true,       // When fetching specific items, show all.
+        'sort'              => 'DESC',     // Sort ASC or DESC
+        'spam'              => 'ham_only', // Retrieve items marked as spam.
         'update_meta_cache' => true,
     ) );
@@ -1650 +1626 @@
         'action'            => '',                     // The activity action - e.g. "Jon Doe posted an update"
         'content'           => '',                     // Optional: The content of the activity item e.g. "BuddyPress is awesome guys!"
-        'component'         => false,                  // The name/ID of the component e.g. groups, profile, mycomponent
-        'type'              => false,                  // The activity type e.g. activity_update, profile_updated
-        'primary_link'      => '',                     // Optional: The primary URL for this item in RSS feeds (defaults to activity permalink)
+        'component'         => false,                  // The name/ID of the component e.g. groups, profile, mycomponent.
+        'type'              => false,                  // The activity type e.g. activity_update, profile_updated.
+        'primary_link'      => '',                     // Optional: The primary URL for this item in RSS feeds (defaults to activity permalink).
         'user_id'           => bp_loggedin_user_id(),  // Optional: The user to record the activity for, can be false if this activity is not for a user.
-        'item_id'           => false,                  // Optional: The ID of the specific item being recorded, e.g. a blog_id
-        'secondary_item_id' => false,                  // Optional: A second ID used to further filter e.g. a comment_id
-        'recorded_time'     => bp_core_current_time(), // The GMT time that this activity was recorded
+        'item_id'           => false,                  // Optional: The ID of the specific item being recorded, e.g. a blog_id.
+        'secondary_item_id' => false,                  // Optional: A second ID used to further filter e.g. a comment_id.
+        'recorded_time'     => bp_core_current_time(), // The GMT time that this activity was recorded.
         'hide_sitewide'     => false,                  // Should this be hidden on the sitewide activity stream?
         'is_spam'           => false,                  // Is this activity item to be marked as spam?
     ), 'activity_add' );
 
-    // Make sure we are backwards compatible
+    // Make sure we are backwards compatible.
     if ( empty( $r['component'] ) && !empty( $r['component_name'] ) ) {
         $r['component'] = $r['component_name'];
@@ -1670 +1646 @@
     }
 
-    // Setup activity to be added
+    // Setup activity to be added.
     $activity                    = new BP_Activity_Activity( $r['id'] );
     $activity->user_id           = $r['user_id'];
@@ -1690 +1666 @@
     }
 
-    // If this is an activity comment, rebuild the tree
+    // If this is an activity comment, rebuild the tree.
     if ( 'activity_comment' === $activity->type ) {
-        // Also clear the comment cache for the parent activity ID
+        // Also clear the comment cache for the parent activity ID.
         wp_cache_delete( $activity->item_id, 'bp_activity_comments' );
 
@@ -1749 +1725 @@
     }
 
-    // Record this on the user's profile
+    // Record this on the user's profile.
     $activity_content = $r['content'];
     $primary_link     = bp_core_get_userlink( $r['user_id'], false, true );
@@ -1771 +1747 @@
     $add_primary_link = apply_filters( 'bp_activity_new_update_primary_link', $primary_link );
 
-    // Now write the values
+    // Now write the values.
     $activity_id = bp_activity_add( array(
         'user_id'      => $r['user_id'],
@@ -1815 +1791 @@
  * @since 2.2.0
  *
- * @param  int      $post_id ID of the new post.
- * @param  WP_Post  $post    Post object.
- * @param  int      $user_id ID of the post author.
- *
+ * @param int     $post_id ID of the new post.
+ * @param WP_Post $post    Post object.
+ * @param int     $user_id ID of the post author.
  * @return int|bool The ID of the activity on success. False on error.
  */
@@ -1953 +1928 @@
  * @since 2.2.0
  *
- * @param  WP_Post $post Post item.
- *
- * @return bool    True on success, false on failure.
+ * @param WP_Post $post Post item.
+ * @return bool True on success, false on failure.
  */
 function bp_activity_post_type_update( $post = null ) {
@@ -2024 +1998 @@
  * @param  int     $post_id ID of the post being unpublished.
  * @param  WP_Post $post    Post object.
- *
- * @return bool    True on success, false on failure.
+ * @return bool True on success, false on failure.
  */
 function bp_activity_post_type_unpublish( $post_id = 0, $post = null ) {
@@ -2033 +2006 @@
     }
 
-    // Get the post type tracking args
+    // Get the post type tracking args.
     $activity_post_object = bp_activity_get_post_type_tracking_args( $post->post_type );
 
@@ -2106 +2079 @@
         'content'     => false,
         'user_id'     => bp_loggedin_user_id(),
-        'activity_id' => false, // ID of the root activity item
-        'parent_id'   => false  // ID of a parent comment (optional)
+        'activity_id' => false, // ID of the root activity item.
+        'parent_id'   => false  // ID of a parent comment (optional).
     ) );
 
-    // Bail if missing necessary data
+    // Bail if missing necessary data.
     if ( empty( $r['content'] ) || empty( $r['user_id'] ) || empty( $r['activity_id'] ) ) {
         $errors->add( 'missing_data', $feedback );
@@ -2118 +2091 @@
     }
 
-    // Maybe set current activity ID as the parent
+    // Maybe set current activity ID as the parent.
     if ( empty( $r['parent_id'] ) ) {
         $r['parent_id'] = $r['activity_id'];
@@ -2125 +2098 @@
     $activity_id = $r['activity_id'];
 
-    // Get the parent activity
+    // Get the parent activity.
     $activity  = new BP_Activity_Activity( $activity_id );
 
-    // Bail if the parent activity does not exist
+    // Bail if the parent activity does not exist.
     if ( empty( $activity->date_recorded ) ) {
         $errors->add( 'missing_activity', __( 'Sorry, the item you are replying to no longer exists.', 'buddypress' ) );
@@ -2148 +2121 @@
     $comment_content = apply_filters( 'bp_activity_comment_content', $r['content'] );
 
-    // Insert the activity comment
+    // Insert the activity comment.
     $comment_id = bp_activity_add( array(
         'id'                => $r['id'],
@@ -2160 +2133 @@
     ) );
 
-    // Comment caches are stored only with the top-level item
+    // Comment caches are stored only with the top-level item.
     wp_cache_delete( $activity_id, 'bp_activity_comments' );
 
-    // Walk the tree to clear caches for all parent items
+    // Walk the tree to clear caches for all parent items.
     $clear_id = $r['parent_id'];
     while ( $clear_id != $activity_id ) {
@@ -2202 +2175 @@
  *
  * @param array|string $args See BP_Activity_Activity::get() for description.
- *
  * @return int $activity_id The ID of the activity item found.
  */
@@ -2268 +2240 @@
  *                           the same as BP_Activity_Activity::get().
  *                           See that method for a description.
- *
  * @return bool True on success, false on failure.
  */
 function bp_activity_delete( $args = '' ) {
 
-    // Pass one or more the of following variables to delete by those variables
+    // Pass one or more the of following variables to delete by those variables.
     $args = bp_parse_args( $args, array(
         'id'                => false,
@@ -2297 +2268 @@
     do_action( 'bp_before_activity_delete', $args );
 
-    // Adjust the new mention count of any mentioned member
+    // Adjust the new mention count of any mentioned member.
     bp_activity_adjust_mention_count( $args['id'], 'delete' );
 
@@ -2305 +2276 @@
     }
 
-    // Check if the user's latest update has been deleted
+    // Check if the user's latest update has been deleted.
     $user_id = empty( $args['user_id'] )
         ? bp_loggedin_user_id()
@@ -2353 +2324 @@
      * @param array|string $args See BP_Activity_Activity::get for a
      *                           description of accepted arguments.
-     *
      * @return bool True on success, false on failure.
      */
@@ -2377 +2347 @@
      *
      * @param int $activity_id ID of the activity item to be deleted.
-     *
      * @return bool True on success, false on failure.
      */
@@ -2398 +2367 @@
      * @param string $component The activity component.
      * @param string $type      The activity type.
-     *
      * @return bool True on success, false on failure.
      */
@@ -2422 +2390 @@
      * @param int    $user_id   The user id.
      * @param string $component The activity component.
-     *
      * @return bool True on success, false on failure.
      */
@@ -2450 +2417 @@
  *                         oldest ancestor.
  * @param int $comment_id  The ID of the comment to be deleted.
- *
  * @return bool True on success, false on failure.
  */
@@ -2474 +2440 @@
     bp_activity_delete_children( $activity_id, $comment_id );
 
-    // Delete the actual comment
+    // Delete the actual comment.
     if ( ! bp_activity_delete( array( 'id' => $comment_id, 'type' => 'activity_comment' ) ) ) {
         return false;
     }
 
-    // Purge comment cache for the root activity update
+    // Purge comment cache for the root activity update.
     wp_cache_delete( $activity_id, 'bp_activity_comments' );
 
-    // Recalculate the comment tree
+    // Recalculate the comment tree.
     BP_Activity_Activity::rebuild_activity_comment_tree( $activity_id );
 
@@ -2513 +2479 @@
     function bp_activity_delete_children( $activity_id, $comment_id ) {
 
-        // Get activity children to delete
+        // Get activity children to delete.
         $children = BP_Activity_Activity::get_child_comments( $comment_id );
 
@@ -2523 +2489 @@
         }
 
-        // Delete the comment itself
+        // Delete the comment itself.
         bp_activity_delete( array(
             'secondary_item_id' => $comment_id,
@@ -2547 +2513 @@
  * @param int         $activity_id  The unique id of the activity object.
  * @param object|bool $activity_obj Optional. The activity object.
- *
  * @return string $link Permalink for the activity item.
  */
@@ -2600 +2565 @@
  *
  * @param int $user_id The ID of the user whose activity is being hidden.
- *
  * @return bool True on success, false on failure.
  */
@@ -2629 +2593 @@
  * @param array|bool  $args    Optional. The args passed to the activity
  *                             creation function (eg bp_blogs_record_activity()).
- *
  * @return string $content The content with images stripped and replaced with a
  *                         single thumb.
@@ -2637 +2600 @@
     preg_match_all( '/<img[^>]*>/Ui', $content, $matches );
 
-    // Remove <img> tags. Also remove caption shortcodes and caption text if present
+    // Remove <img> tags. Also remove caption shortcodes and caption text if present.
     $content = preg_replace('|(\[caption(.*?)\])?<img[^>]*>([^\[\[]*\[\/caption\])?|', '', $content );
 
     if ( !empty( $matches ) && !empty( $matches[0] ) ) {
 
-        // Get the SRC value
+        // Get the SRC value.
         preg_match( '/<img.*?(src\=[\'|"]{0,1}.*?[\'|"]{0,1})[\s|>]{1}/i',    $matches[0][0], $src    );
 
-        // Get the width and height
+        // Get the width and height.
         preg_match( '/<img.*?(height\=[\'|"]{0,1}.*?[\'|"]{0,1})[\s|>]{1}/i', $matches[0][0], $height );
         preg_match( '/<img.*?(width\=[\'|"]{0,1}.*?[\'|"]{0,1})[\s|>]{1}/i',  $matches[0][0], $width  );
@@ -2702 +2665 @@
  * @param array  $activity The data passed to bp_activity_add() or the values
  *                         from an Activity obj.
- *
- * @return string
+ * @return string $summary
  */
 function bp_activity_create_summary( $content, $activity ) {
@@ -2886 +2848 @@
     $activity->is_spam = 1;
 
-    // Clear the activity stream first page cache
+    // Clear the activity stream first page cache.
     wp_cache_delete( 'bp_activity_sitewide_front', 'bp' );
 
-    // Clear the activity comment cache for this activity item
+    // Clear the activity comment cache for this activity item.
     wp_cache_delete( $activity->id, 'bp_activity_comments' );
 
-    // If Akismet is active, and this was a manual spam/ham request, stop Akismet checking the activity
+    // If Akismet is active, and this was a manual spam/ham request, stop Akismet checking the activity.
     if ( 'by_a_person' == $source && !empty( $bp->activity->akismet ) ) {
         remove_action( 'bp_activity_before_save', array( $bp->activity->akismet, 'check_activity' ), 4, 1 );
 
-        // Build data package for Akismet
+        // Build data package for Akismet.
         $activity_data = BP_Akismet::build_akismet_data_package( $activity );
 
-        // Tell Akismet this is spam
+        // Tell Akismet this is spam.
         $activity_data = $bp->activity->akismet->send_akismet_request( $activity_data, 'submit', 'spam' );
 
-        // Update meta
+        // Update meta.
         add_action( 'bp_activity_after_save', array( $bp->activity->akismet, 'update_activity_spam_meta' ), 1, 1 );
     }
@@ -2933 +2895 @@
     $activity->is_spam = 0;
 
-    // Clear the activity stream first page cache
+    // Clear the activity stream first page cache.
     wp_cache_delete( 'bp_activity_sitewide_front', 'bp' );
 
-    // Clear the activity comment cache for this activity item
+    // Clear the activity comment cache for this activity item.
     wp_cache_delete( $activity->id, 'bp_activity_comments' );
 
-    // If Akismet is active, and this was a manual spam/ham request, stop Akismet checking the activity
+    // If Akismet is active, and this was a manual spam/ham request, stop Akismet checking the activity.
     if ( 'by_a_person' == $source && !empty( $bp->activity->akismet ) ) {
         remove_action( 'bp_activity_before_save', array( $bp->activity->akismet, 'check_activity' ), 4, 1 );
 
-        // Build data package for Akismet
+        // Build data package for Akismet.
         $activity_data = BP_Akismet::build_akismet_data_package( $activity );
 
-        // Tell Akismet this is spam
+        // Tell Akismet this is spam.
         $activity_data = $bp->activity->akismet->send_akismet_request( $activity_data, 'submit', 'ham' );
 
-        // Update meta
+        // Update meta.
         add_action( 'bp_activity_after_save', array( $bp->activity->akismet, 'update_activity_ham_meta' ), 1, 1 );
     }
@@ -3072 +3034 @@
  * @param int    $id       The ID of the activity item.
  * @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
- *
  * @return mixed The cached embeds for this activity item.
  */
@@ -3093 +3054 @@
  * @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
  * @param int    $id       The ID of the activity item.
- *
- * @return bool True on success, false on failure.
  */
 function bp_embed_activity_save_cache( $cache, $cachekey, $id ) {

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

@@ -9 +9 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -47 +47 @@
     public function includes( $includes = array() ) {
 
-        // Files to include
+        // Files to include.
         $includes = array(
             'cssjs',
@@ -60 +60 @@
         );
 
-        // Load Akismet support if Akismet is configured
+        // Load Akismet support if Akismet is configured.
         $akismet_key = bp_get_option( 'wordpress_api_key' );
 
@@ -90 +90 @@
         $bp = buddypress();
 
-        // Define a slug, if necessary
+        // Define a slug, if necessary.
         if ( ! defined( 'BP_ACTIVITY_SLUG' ) ) {
             define( 'BP_ACTIVITY_SLUG', $this->id );
         }
 
-        // Global tables for activity component
+        // Global tables for activity component.
         $global_tables = array(
             'table_name'      => $bp->table_prefix . 'bp_activity',
@@ -101 +101 @@
         );
 
-        // Metadata tables for groups component
+        // Metadata tables for groups component.
         $meta_tables = array(
             'activity' => $bp->table_prefix . 'bp_activity_meta',
@@ -138 +138 @@
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
-        // Stop if there is no user displayed or logged in
+        // Stop if there is no user displayed or logged in.
         if ( ! is_user_logged_in() && ! bp_displayed_user_id() ) {
             return;
         }
 
-        // Determine user to use
+        // Determine user to use.
         if ( bp_displayed_user_domain() ) {
             $user_domain = bp_displayed_user_domain();
@@ -155 +155 @@
         $activity_link = trailingslashit( $user_domain . $slug );
 
-        // Add 'Activity' to the main navigation
+        // Add 'Activity' to the main navigation.
         $main_nav = array(
             'name'                => _x( 'Activity', 'Profile activity screen nav', 'buddypress' ),
@@ -165 +165 @@
         );
 
-        // Add the subnav items to the activity nav item if we are using a theme that supports this
+        // Add the subnav items to the activity nav item if we are using a theme that supports this.
         $sub_nav[] = array(
             'name'            => _x( 'Personal', 'Profile activity screen sub nav', 'buddypress' ),
@@ -175 +175 @@
         );
 
-        // @ mentions
+        // Check @mentions.
         if ( bp_activity_do_mentions() ) {
             $sub_nav[] = array(
@@ -188 +188 @@
         }
 
-        // Favorite activity items
+        // Favorite activity items.
         if ( bp_activity_can_favorite() ) {
             $sub_nav[] = array(
@@ -201 +201 @@
         }
 
-        // Additional menu if friends is active
+        // Additional menu if friends is active.
         if ( bp_is_active( 'friends' ) ) {
             $sub_nav[] = array(
@@ -214 +214 @@
         }
 
-        // Additional menu if groups is active
+        // Additional menu if groups is active.
         if ( bp_is_active( 'groups' ) ) {
             $sub_nav[] = array(
@@ -250 +250 @@
     public function setup_admin_bar( $wp_admin_nav = array() ) {
 
-        // Menus for logged in user
+        // Menus for logged in user.
         if ( is_user_logged_in() ) {
 
-            // Setup the logged in user variables
+            // Setup the logged in user variables.
             $activity_link = trailingslashit( bp_loggedin_user_domain() . bp_get_activity_slug() );
 
-            // Unread message count
+            // Unread message count.
             if ( bp_activity_do_mentions() ) {
                 $count = bp_get_total_mention_count_for_user( bp_loggedin_user_id() );
@@ -266 +266 @@
             }
 
-            // Add the "Activity" sub menu
+            // Add the "Activity" sub menu.
             $wp_admin_nav[] = array(
                 'parent' => buddypress()->my_account_menu_id,
@@ -274 +274 @@
             );
 
-            // Personal
+            // Personal.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -282 +282 @@
             );
 
-            // Mentions
+            // Mentions.
             if ( bp_activity_do_mentions() ) {
                 $wp_admin_nav[] = array(
@@ -292 +292 @@
             }
 
-            // Favorites
-            // Favorite activity items
+            // Favorite activity items.
             if ( bp_activity_can_favorite() ) {
                 $wp_admin_nav[] = array(
@@ -338 +337 @@
     public function setup_title() {
 
-        // Adjust title based on view
+        // Adjust title based on view.
         if ( bp_is_activity_component() ) {
             $bp = buddypress();
@@ -364 +363 @@
     public function setup_actions() {
 
-        // Spam prevention
+        // Spam prevention.
         add_action( 'bp_include', 'bp_activity_setup_akismet' );
 
@@ -377 +376 @@
     public function setup_cache_groups() {
 
-        // Global groups
+        // Global groups.
         wp_cache_add_global_groups( array(
             'bp_activity',

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -41 +41 @@
 function bp_activity_at_message_notification( $activity_id, $receiver_user_id ) {
 
-    // Don't leave multiple notifications for the same activity item
+    // Don't leave multiple notifications for the same activity item.
     $notifications = BP_Core_Notification::get_all_for_user( $receiver_user_id, 'all' );
 
@@ -56 +56 @@
     $content = '';
 
-    // Now email the user with the contents of the message (if they have enabled email notifications)
+    // Now email the user with the contents of the message (if they have enabled email notifications).
     if ( 'no' != bp_get_user_meta( $receiver_user_id, 'notification_activity_new_mention', true ) ) {
         $poster_name = bp_core_get_user_displayname( $activity->user_id );
@@ -67 +67 @@
         $content = bp_activity_filter_kses( strip_tags( stripslashes( $activity->content ) ) );
 
-        // Set up and send the message
+        // Set up and send the message.
         $ud       = bp_core_get_core_userdata( $receiver_user_id );
         $to       = $ud->user_email;
@@ -94 +94 @@
         }
 
-        // Only show the disable notifications line if the settings component is enabled
+        // Only show the disable notifications line if the settings component is enabled.
         if ( bp_is_active( 'settings' ) ) {
             $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
@@ -175 +175 @@
  * @param int   $comment_id   The comment id.
  * @param int   $commenter_id The ID of the user who posted the comment.
- * @param array $params       {@link bp_activity_new_comment()}
- *
+ * @param array $params       {@link bp_activity_new_comment()}.
  * @return bool
  */
 function bp_activity_new_comment_notification( $comment_id = 0, $commenter_id = 0, $params = array() ) {
 
-    // Set some default parameters
+    // Set some default parameters.
     $activity_id = 0;
     $parent_id   = 0;
@@ -198 +197 @@
         $content = bp_activity_filter_kses( stripslashes($content) );
 
-        // Set up and send the message
+        // Set up and send the message.
         $ud      = bp_core_get_core_userdata( $original_activity->user_id );
         $to      = $ud->user_email;
@@ -212 +211 @@
 ', 'buddypress' ), $poster_name, $content, $thread_link );
 
-        // Only show the disable notifications line if the settings component is enabled
+        // Only show the disable notifications line if the settings component is enabled.
         if ( bp_is_active( 'settings' ) ) {
             $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
@@ -266 +265 @@
     }
 
-    /***
+    /*
      * If this is a reply to another comment, send an email notification to the
      * author of the immediate parent comment.
@@ -282 +281 @@
         $settings_link = bp_core_get_user_domain( $parent_comment->user_id ) . $settings_slug . '/notifications/';
 
-        // Set up and send the message
+        // Set up and send the message.
         $ud       = bp_core_get_core_userdata( $parent_comment->user_id );
         $to       = $ud->user_email;
@@ -300 +299 @@
 ', 'buddypress' ), $poster_name, $content, $thread_link );
 
-        // Only show the disable notifications line if the settings component is enabled
+        // Only show the disable notifications line if the settings component is enabled.
         if ( bp_is_active( 'settings' ) ) {
             $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
@@ -360 +359 @@
  * @since 1.9.0
  *
- * @param int   $comment_id
- * @param array $params
+ * @param int   $comment_id ID of the comment being notified about.
+ * @param array $params     Parameters to use with notification.
  */
 function bp_activity_new_comment_notification_helper( $comment_id, $params ) {
@@ -387 +386 @@
  * @param int    $total_items       The total number of notifications to format.
  * @param string $format            'string' to get a BuddyBar-compatible notification, 'array' otherwise.
- *
  * @return string $return Formatted @mention notification.
  */
@@ -476 +474 @@
  * @since 1.9.0
  *
- * @param object $activity
- * @param string $subject (not used)
- * @param string $message (not used)
- * @param string $content (not used)
- * @param int    $receiver_user_id
+ * @param object $activity           Activity object.
+ * @param string $subject (not used) Notification subject.
+ * @param string $message (not used) Notification message.
+ * @param string $content (not used) Notification content.
+ * @param int    $receiver_user_id   ID of user receiving notification.
  */
 function bp_activity_at_mention_add_notification( $activity, $subject, $message, $content, $receiver_user_id ) {
@@ -509 +507 @@
     }
 
-    // Only mark read if you're looking at your own mentions
+    // Only mark read if you're looking at your own mentions.
     if ( ! bp_is_my_profile() ) {
         return;
@@ -523 +521 @@
  * @since 2.0.0
  *
- * @param object BP_Activity_Activity
+ * @param BP_Activity_Activity $activity Activity object.
  */
 function bp_activity_remove_screen_notifications_single_activity_permalink( $activity ) {
@@ -534 +532 @@
     }
 
-    // Mark as read any notifications for the current user related to this
-    // activity item
+    // Mark as read any notifications for the current user related to this activity item.
     bp_notifications_mark_notifications_by_item_id( bp_loggedin_user_id(), $activity->id, buddypress()->activity->id, 'new_at_mention' );
 }
@@ -549 +546 @@
 function bp_activity_at_mention_delete_notification( $activity_ids_deleted = array() ) {
     // Let's delete all without checking if content contains any mentions
-    // to avoid a query to get the activity
+    // to avoid a query to get the activity.
     if ( bp_is_active( 'notifications' ) && ! empty( $activity_ids_deleted ) ) {
         foreach ( $activity_ids_deleted as $activity_id ) {

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

@@ -11 +11 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -253 +253 @@
     $bp = buddypress();
 
-    // No displayed user or not viewing activity component
+    // No displayed user or not viewing activity component.
     if ( !bp_is_activity_component() )
         return false;
@@ -260 +260 @@
         return false;
 
-    // Get the activity details
+    // Get the activity details.
     $activity = bp_activity_get_specific( array( 'activity_ids' => bp_current_action(), 'show_hidden' => true, 'spam' => 'ham_only', ) );
 
@@ -272 +272 @@
     }
 
-    // Default access is true
+    // Default access is true.
     $has_access = true;
 
-    // If activity is from a group, do an extra cap check
+    // If activity is from a group, do an extra cap check.
     if ( isset( $bp->groups->id ) && $activity->component == $bp->groups->id ) {
 
-        // Activity is from a group, but groups is currently disabled
+        // Activity is from a group, but groups is currently disabled.
         if ( !bp_is_active( 'groups') ) {
             bp_do_404();
@@ -285 +285 @@
 
         // Check to see if the group is not public, if so, check the
-        // user has access to see this activity
+        // user has access to see this activity.
         if ( $group = groups_get_group( array( 'group_id' => $activity->item_id ) ) ) {
 
-            // Group is not public
+            // Group is not public.
             if ( 'public' != $group->status ) {
 
-                // User is not a member of group
+                // User is not a member of group.
                 if ( !groups_is_user_member( bp_loggedin_user_id(), $group->id ) ) {
                     $has_access = false;
@@ -318 +318 @@
     do_action( 'bp_activity_screen_single_activity_permalink', $activity, $has_access );
 
-    // Access is specifically disallowed
+    // Access is specifically disallowed.
     if ( false === $has_access ) {
 
-        // User feedback
+        // User feedback.
         bp_core_add_message( __( 'You do not have access to this activity.', 'buddypress' ), 'error' );
 
-        // Redirect based on logged in status
+        // Redirect based on logged in status.
         if ( is_user_logged_in() ) {
             $url = bp_loggedin_user_domain();
@@ -442 +442 @@
     public function is_activity() {
 
-        // Bail if not looking at a group
+        // Bail if not looking at a group.
         if ( ! bp_is_activity_component() )
             return;
 
-        // Activity Directory
+        // Activity Directory.
         if ( ! bp_displayed_user_id() && ! bp_current_action() ) {
             bp_update_is_directory( true, 'activity' );
@@ -457 +457 @@
             add_filter( 'bp_replace_the_content',                    array( $this, 'directory_content'    ) );
 
-        // Single activity
+        // Single activity.
         } elseif ( bp_is_single_activity() ) {
             add_filter( 'bp_get_buddypress_template',                array( $this, 'single_template_hierarchy' ) );
@@ -475 +475 @@
      *
      * @param string $templates The templates from bp_get_theme_compat_templates().
-     *
      * @return array $templates Array of custom templates to look for.
      */
@@ -492 +491 @@
 
         // Merge new templates with existing stack
-        // @see bp_get_theme_compat_templates()
+        // @see bp_get_theme_compat_templates().
         $templates = array_merge( (array) $new_templates, $templates );
 
@@ -536 +535 @@
      *
      * @param string $templates The templates from bp_get_theme_compat_templates().
-     *
      * @return array $templates Array of custom templates to look for.
      */
@@ -553 +551 @@
 
         // Merge new templates with existing stack
-        // @see bp_get_theme_compat_templates()
+        // @see bp_get_theme_compat_templates().
         $templates = array_merge( (array) $new_templates, $templates );
 

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -114 +114 @@
  */
 class BP_Activity_Template {
+
     /**
      * The loop iterator.
@@ -232 +233 @@
         $bp = buddypress();
 
-        // Backward compatibility with old method of passing arguments
+        // Backward compatibility with old method of passing arguments.
         if ( !is_array( $args ) || func_num_args() > 1 ) {
             _deprecated_argument( __METHOD__, '1.6', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
@@ -285 +286 @@
         $this->pag_num  = bp_sanitize_pagination_arg( 'num',          $r['per_page'] );
 
-        // Check if blog/forum replies are disabled
+        // Check if blog/forum replies are disabled.
         $this->disable_blogforum_replies = (bool) bp_core_get_root_option( 'bp-disable-blogforum-comments' );
 
-        // Get an array of the logged in user's favorite activities
+        // Get an array of the logged in user's favorite activities.
         $this->my_favs = maybe_unserialize( bp_get_user_meta( bp_loggedin_user_id(), 'bp_favorite_activities', true ) );
 
-        // Fetch specific activity items based on ID's
+        // Fetch specific activity items based on ID's.
         if ( !empty( $include ) ) {
             $this->activities = bp_activity_get_specific( array(
@@ -306 +307 @@
             ) );
 
-        // Fetch all activity items
+        // Fetch all activity items.
         } else {
             $this->activities = bp_activity_get( array(
@@ -330 +331 @@
 
         // The total_activity_count property will be set only if a
-        // 'count_total' query has taken place
+        // 'count_total' query has taken place.
         if ( ! is_null( $this->activities['total'] ) ) {
             if ( ! $max || $max >= (int) $this->activities['total'] ) {
@@ -355 +356 @@
         $this->full_name = bp_get_displayed_user_fullname();
 
-        // Fetch parent content for activity comments so we do not have to query in the loop
+        // Fetch parent content for activity comments so we do not have to query in the loop.
         foreach ( (array) $this->activities as $activity ) {
             if ( 'activity_comment' != $activity->type ) {
@@ -451 +452 @@
             do_action( 'activity_loop_end' );
 
-            // Do some cleaning up after the loop
+            // Do some cleaning up after the loop.
             $this->rewind_activities();
         }
@@ -478 +479 @@
         }
 
-        // loop has just started
+        // Loop has just started.
         if ( $this->current_activity == 0 ) {
 
@@ -605 +606 @@
     global $activities_template;
 
-    // Get BuddyPress
+    // Get BuddyPress.
     $bp = buddypress();
 
-    /** Smart Defaults ********************************************************/
-
-    // User filtering
+    /*
+     * Smart Defaults.
+     */
+
+    // User filtering.
     $user_id = bp_displayed_user_id()
         ? bp_displayed_user_id()
         : false;
 
-    // Group filtering
+    // Group filtering.
     if ( bp_is_group() ) {
         $object      = $bp->groups->id;
@@ -626 +629 @@
     }
 
-    // The default scope should recognize custom slugs
+    // The default scope should recognize custom slugs.
     $scope = array_key_exists( bp_current_action(), (array) $bp->loaded_components )
         ? $bp->loaded_components[ bp_current_action() ]
         : bp_current_action();
 
-    // Support for permalinks on single item pages: /groups/my-group/activity/124/
+    // Support for permalinks on single item pages: /groups/my-group/activity/124/.
     $include = bp_is_current_action( bp_get_activity_slug() )
         ? bp_action_variable( 0 )
@@ -642 +645 @@
     }
 
-    /** Parse Args ************************************************************/
+    /*
+     * Parse Args.
+     */
 
     // Note: any params used for filtering can be a single value, or multiple
     // values comma separated.
     $r = bp_parse_args( $args, array(
-        'display_comments'  => 'threaded',   // false for none, stream/threaded - show comments in the stream or threaded under items
-        'include'           => $include,     // pass an activity_id or string of IDs comma-separated
-        'exclude'           => false,        // pass an activity_id or string of IDs comma-separated
-        'in'                => false,        // comma-separated list or array of activity IDs among which to search
-        'sort'              => 'DESC',       // sort DESC or ASC
-        'page'              => 1,            // which page to load
-        'per_page'          => 20,           // number of items per page
-        'page_arg'          => 'acpage',     // See https://buddypress.trac.wordpress.org/ticket/3679
-        'max'               => false,        // max number to return
+        'display_comments'  => 'threaded',   // False for none, stream/threaded - show comments in the stream or threaded under items.
+        'include'           => $include,     // Pass an activity_id or string of IDs comma-separated.
+        'exclude'           => false,        // Pass an activity_id or string of IDs comma-separated.
+        'in'                => false,        // Comma-separated list or array of activity IDs among which to search.
+        'sort'              => 'DESC',       // Sort DESC or ASC.
+        'page'              => 1,            // Which page to load.
+        'per_page'          => 20,           // Number of items per page.
+        'page_arg'          => 'acpage',     // See https://buddypress.trac.wordpress.org/ticket/3679.
+        'max'               => false,        // Max number to return.
         'fields'            => 'all',
         'count_total'       => false,
         'show_hidden'       => $show_hidden, // Show activity items that are hidden site-wide?
-        'spam'              => 'ham_only',   // Hide spammed items
-
-        // Scope - pre-built activity filters for a user (friends/groups/favorites/mentions)
+        'spam'              => 'ham_only',   // Hide spammed items.
+
+        // Scope - pre-built activity filters for a user (friends/groups/favorites/mentions).
         'scope'             => $scope,
 
         // Filtering
-        'user_id'           => $user_id,     // user_id to filter on
-        'object'            => $object,      // object to filter on e.g. groups, profile, status, friends
-        'action'            => false,        // action to filter on e.g. activity_update, new_forum_post, profile_updated
-        'primary_id'        => $primary_id,  // object ID to filter on e.g. a group_id or forum_id or blog_id etc.
-        'secondary_id'      => false,        // secondary object ID to filter on e.g. a post_id
-        'offset'            => false,        // return only items >= this ID
-        'since'             => false,        // return only items recorded since this Y-m-d H:i:s date
-
-        'meta_query'        => false,        // filter on activity meta. See WP_Meta_Query for format
-        'date_query'        => false,        // filter by date. See first parameter of WP_Date_Query for format
-        'filter_query'      => false,        // advanced filtering.  See BP_Activity_Query for format
-
-        // Searching
+        'user_id'           => $user_id,     // user_id to filter on.
+        'object'            => $object,      // Object to filter on e.g. groups, profile, status, friends.
+        'action'            => false,        // Action to filter on e.g. activity_update, new_forum_post, profile_updated.
+        'primary_id'        => $primary_id,  // Object ID to filter on e.g. a group_id or forum_id or blog_id etc.
+        'secondary_id'      => false,        // Secondary object ID to filter on e.g. a post_id.
+        'offset'            => false,        // Return only items >= this ID.
+        'since'             => false,        // Return only items recorded since this Y-m-d H:i:s date.
+
+        'meta_query'        => false,        // Filter on activity meta. See WP_Meta_Query for format.
+        'date_query'        => false,        // Filter by date. See first parameter of WP_Date_Query for format.
+        'filter_query'      => false,        // Advanced filtering.  See BP_Activity_Query for format.
+
+        // Searching.
         'search_terms'      => $search_terms_default,
         'update_meta_cache' => true,
     ), 'has_activities' );
 
-    /** Smart Overrides *******************************************************/
+    /*
+     * Smart Overrides.
+     */
 
     // Translate various values for 'display_comments'
     // This allows disabling comments via ?display_comments=0
-    // or =none or =false. Final true is a strict type check. See #5029
+    // or =none or =false. Final true is a strict type check. See #5029.
     if ( in_array( $r['display_comments'], array( 0, '0', 'none', 'false' ), true ) ) {
         $r['display_comments'] = false;
     }
 
-    // Ignore pagination if an offset is passed
+    // Ignore pagination if an offset is passed.
     if ( ! empty( $r['offset'] ) ) {
         $r['page'] = 0;
     }
 
-    // Search terms
+    // Search terms.
     if ( ! empty( $_REQUEST['s'] ) && empty( $r['search_terms'] ) ) {
         $r['search_terms'] = $_REQUEST['s'];
     }
 
-    // Do not exceed the maximum per page
+    // Do not exceed the maximum per page.
     if ( ! empty( $r['max'] ) && ( (int) $r['per_page'] > (int) $r['max'] ) ) {
         $r['per_page'] = $r['max'];
@@ -741 +748 @@
     }
 
-    /** Query *****************************************************************/
+    /*
+     * Query
+     */
 
     $activities_template = new BP_Activity_Template( $r );
@@ -799 +808 @@
      *
      * @since 2.1.0
+     *
+     * @return string $link
      */
     function bp_get_activity_load_more_link() {
@@ -1317 +1328 @@
      *
      * @todo Properly deprecate in favor of bp_activity_type() and
-     *       remove redundant echo
+     *       remove redundant echo
      *
      * @uses bp_activity_type()
@@ -1461 +1472 @@
         $bp = buddypress();
 
-        // On activity permalink pages, default to the full-size avatar
+        // On activity permalink pages, default to the full-size avatar.
         $type_default = bp_is_single_activity() ? 'full' : 'thumb';
 
@@ -1468 +1479 @@
         $current_activity_item = isset( $activities_template->activity->current_comment ) ? $activities_template->activity->current_comment : $activities_template->activity;
 
-        // Activity user display name
+        // Activity user display name.
         $dn_default  = isset( $current_activity_item->display_name ) ? $current_activity_item->display_name : '';
 
-        // Prepend some descriptive text to alt
+        // Prepend some descriptive text to alt.
         $alt_default = !empty( $dn_default ) ? sprintf( __( 'Profile picture of %s', 'buddypress' ), $dn_default ) : __( 'Profile picture', 'buddypress' );
 
@@ -1487 +1498 @@
         if ( !isset( $height ) && !isset( $width ) ) {
 
-            // Backpat
+            // Backpat.
             if ( isset( $bp->avatar->full->height ) || isset( $bp->avatar->thumb->height ) ) {
                 $height = ( 'full' == $type ) ? $bp->avatar->full->height : $bp->avatar->thumb->height;
@@ -1494 +1505 @@
             }
 
-            // Backpat
+            // Backpat.
             if ( isset( $bp->avatar->full->width ) || isset( $bp->avatar->thumb->width ) ) {
                 $width = ( 'full' == $type ) ? $bp->avatar->full->width : $bp->avatar->thumb->width;
@@ -1587 +1598 @@
      *     @type int|bool    $user_id Default: ID of the activity's user.
      * }
-     * @return string The secondary avatar
+     * @return string The secondary avatar.
      */
     function bp_get_activity_secondary_avatar( $args = '' ) {
@@ -1604 +1615 @@
         extract( $r, EXTR_SKIP );
 
-        // Set item_id and object (default to user)
+        // Set item_id and object (default to user).
         switch ( $activities_template->activity->component ) {
             case 'groups' :
@@ -1616 +1627 @@
                 $name    = '';
 
-                // Only if groups is active
+                // Only if groups is active.
                 if ( bp_is_active( 'groups' ) ) {
                     $group = groups_get_group( array(
@@ -1691 +1702 @@
         $item_id = apply_filters( 'bp_get_activity_secondary_avatar_item_id', $item_id );
 
-        // If we have no item_id or object, there is no avatar to display
+        // If we have no item_id or object, there is no avatar to display.
         if ( empty( $item_id ) || empty( $object ) ) {
             return false;
         }
 
-        // Get the avatar
+        // Get the avatar.
         $avatar = bp_core_fetch_avatar( array(
             'item_id' => $item_id,
@@ -1745 +1756 @@
  * @since 1.2.0
  *
- * @param array $args See bp_get_activity_action()
+ * @param array $args See bp_get_activity_action().
  * @uses bp_get_activity_action()
  */
@@ -1758 +1769 @@
      *
      * @global object $activities_template {@link BP_Activity_Template}
-     * @param array $args Only parameter is "no_timestamp". If true, timestamp is shown in output.
      * @uses apply_filters_ref_array() To call the 'bp_get_activity_action_pre_meta' hook.
      * @uses bp_insert_activity_meta()
@@ -1789 +1799 @@
         ) );
 
-        // Prepend the activity action meta (link, time since, etc...)
+        // Prepend the activity action meta (link, time since, etc...).
         if ( ! empty( $action ) && empty( $r['no_timestamp'] ) ) {
             $action = bp_insert_activity_meta( $action );
@@ -1833 +1843 @@
         global $activities_template;
 
-        // Backwards compatibility if action is not being used
+        // Backwards compatibility if action is not being used.
         if ( empty( $activities_template->activity->action ) && ! empty( $activities_template->activity->content ) ) {
             $activities_template->activity->content = bp_insert_activity_meta( $activities_template->activity->content );
@@ -1925 +1935 @@
  *
  * @param string $content The activity content.
- *
  * @return string The activity content with the metadata string attached.
  */
@@ -1931 +1940 @@
     global $activities_template;
 
-    // Strip any legacy time since placeholders from BP 1.0-1.1
+    // Strip any legacy time since placeholders from BP 1.0-1.1.
     $new_content = str_replace( '<span class="time-since">%s</span>', '', $content );
 
-    // Get the time since this activity was recorded
+    // Get the time since this activity was recorded.
     $date_recorded  = bp_core_time_since( $activities_template->activity->date_recorded );
 
@@ -1949 +1958 @@
     ) );
 
-    // Insert the permalink
+    // Insert the permalink.
     if ( ! bp_is_single_activity() ) {
 
-        // Setup variables for activity meta
+        // Setup variables for activity meta.
         $activity_permalink = bp_activity_get_permalink( $activities_template->activity->id, $activities_template->activity );
         $activity_meta      = sprintf( '%1$s <a href="%2$s" class="view activity-time-since" title="%3$s">%4$s</a>',
@@ -1966 +1975 @@
          * @since 1.2.0
          *
-         * @param array $value Array containing the html markup for the activity permalink, after being parsed by sprintf and current activity component.
+         * @param array $value Array containing the html markup for the activity permalink, after being parsed by
+         *                     sprintf and current activity component.
          */
         $new_content = apply_filters_ref_array( 'bp_activity_permalink', array(
@@ -1995 +2005 @@
  *
  * @param object|bool $activity Optional. Falls back on the current item in the loop.
- *
  * @return bool True if can delete, false otherwise.
  */
@@ -2001 +2010 @@
     global $activities_template;
 
-    // Try to use current activity if none was passed
+    // Try to use current activity if none was passed.
     if ( empty( $activity ) && ! empty( $activities_template->activity ) ) {
         $activity = $activities_template->activity;
     }
 
-    // If current_comment is set, we'll use that in place of the main activity
+    // If current_comment is set, we'll use that in place of the main activity.
     if ( isset( $activity->current_comment ) ) {
         $activity = $activity->current_comment;
     }
 
-    // Assume the user cannot delete the activity item
+    // Assume the user cannot delete the activity item.
     $can_delete = false;
 
-    // Only logged in users can delete activity
+    // Only logged in users can delete activity.
     if ( is_user_logged_in() ) {
 
-        // Community moderators can always delete activity (at least for now)
+        // Community moderators can always delete activity (at least for now).
         if ( bp_current_user_can( 'bp_moderate' ) ) {
             $can_delete = true;
@@ -2029 +2038 @@
         }
 
-        // Viewing a single item, and this user is an admin of that item
+        // Viewing a single item, and this user is an admin of that item.
         if ( bp_is_single_item() && bp_is_item_admin() ) {
             $can_delete = true;
@@ -2069 +2078 @@
      *
      * @param string $args Unused. Left over from an earlier implementation.
-     *
      * @return mixed False on failure, otherwise the activity parent content.
      */
@@ -2075 +2083 @@
         global $activities_template;
 
-        // Bail if no activity on no item ID
+        // Bail if no activity on no item ID.
         if ( empty( $activities_template->activity ) || empty( $activities_template->activity->item_id ) ) {
             return false;
         }
 
-        // Get the ID of the parent activity content
+        // Get the ID of the parent activity content.
         $parent_id = (int) $activities_template->activity->item_id;
 
-        // Bail if no parent content
+        // Bail if no parent content.
         if ( empty( $activities_template->activity_parents[ $parent_id ] ) ) {
             return false;
         }
 
-        // Bail if no action
+        // Bail if no action.
         if ( empty( $activities_template->activity_parents[ $parent_id ]->action ) ) {
             return false;
         }
 
-        // Content always includes action
+        // Content always includes action.
         $content = $activities_template->activity_parents[ $parent_id ]->action;
 
-        // Maybe append activity content, if it exists
+        // Maybe append activity content, if it exists.
         if ( ! empty( $activities_template->activity_parents[ $parent_id ]->content ) ) {
             $content .= ' ' . $activities_template->activity_parents[ $parent_id ]->content;
         }
 
-        // Remove the time since content for backwards compatibility
+        // Remove the time since content for backwards compatibility.
         $content = str_replace( '<span class="time-since">%s</span>', '', $content );
 
-        // Remove images
+        // Remove images.
         $content = preg_replace( '/<img[^>]*>/Ui', '', $content );
 
@@ -2139 +2147 @@
         global $activities_template;
 
-        // Bail if no activity on no item ID
+        // Bail if no activity on no item ID.
         if ( empty( $activities_template->activity ) || empty( $activities_template->activity->item_id ) ) {
             return false;
         }
 
-        // Get the ID of the parent activity content
+        // Get the ID of the parent activity content.
         $parent_id = (int) $activities_template->activity->item_id;
 
-        // Bail if no parent item
+        // Bail if no parent item.
         if ( empty( $activities_template->activity_parents[ $parent_id ] ) ) {
             return false;
         }
 
-        // Bail if no parent user ID
+        // Bail if no parent user ID.
         if ( empty( $activities_template->activity_parents[ $parent_id ]->user_id ) ) {
             return false;
@@ -2222 +2230 @@
      *
      * @todo deprecate $args param
-     *
      * @todo Given that checks for children already happen in bp_activity_recurse_comments(),
-     *    this function can probably be streamlined or removed.
-     *
-     * @param string $args Unused. Left over from an earlier implementation.
+     *       this function can probably be streamlined or removed.
      *
      * @global object $activities_template {@link BP_Activity_Template}
      * @uses bp_activity_recurse_comments()
      *
+     * @param string $args Unused. Left over from an earlier implementation.
      * @return bool
      */
@@ -2251 +2257 @@
          * @since 1.2.0
          *
-         * @param object $comment The activity object currently being recursed.
-         *
          * @global object $activities_template {@link BP_Activity_Template}
          * @uses locate_template()
          *
+         * @param object $comment The activity object currently being recursed.
          * @return bool|string
          */
@@ -2279 +2284 @@
             foreach ( (array) $comment->children as $comment_child ) {
 
-                // Put the comment into the global so it's available to filters
+                // Put the comment into the global so it's available to filters.
                 $activities_template->activity->current_comment = $comment_child;
 
@@ -2475 +2480 @@
         if ( isset( $activities_template->activity->current_comment->user_fullname ) ) {
 
-            $name = apply_filters( 'bp_acomment_name', $activities_template->activity->current_comment->user_fullname, $activities_template->activity->current_comment );  // backward compatibility
+            $name = apply_filters( 'bp_acomment_name', $activities_template->activity->current_comment->user_fullname, $activities_template->activity->current_comment );  // Backward compatibility.
         } else {
             $name = $activities_template->activity->current_comment->display_name;
@@ -2661 +2666 @@
      * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook.
      *
-     * @param array $deprecated Deprecated.
-     *
+     * @param array|null $deprecated Deprecated.
      * @return int $count The activity comment count.
      */
@@ -2668 +2672 @@
         global $activities_template;
 
-        // Deprecated notice about $args
+        // Deprecated notice about $args.
         if ( ! empty( $deprecated ) ) {
             _deprecated_argument( __FUNCTION__, '1.2', sprintf( __( '%1$s no longer accepts arguments. See the inline documentation at %2$s for more details.', 'buddypress' ), __FUNCTION__, __FILE__ ) );
         }
 
-        // Get the count using the purpose-built recursive function
+        // Get the count using the purpose-built recursive function.
         $count = ! empty( $activities_template->activity->children )
             ? bp_activity_recurse_comment_count( $activities_template->activity )
@@ -2701 +2705 @@
          * @param object $comment Activity comment object.
          * @param int    $count The current iteration count.
-         *
          * @return int $count The activity comment count.
          */
         function bp_activity_recurse_comment_count( $comment, $count = 0 ) {
 
-            // Copy the count
+            // Copy the count.
             $new_count = $count;
 
-            // Loop through children and recursively count comments
+            // Loop through children and recursively count comments.
             if ( ! empty( $comment->children ) ) {
                 foreach ( (array) $comment->children as $comment ) {
@@ -2947 +2950 @@
         global $activities_template;
 
-        // Check that comment exists
+        // Check that comment exists.
         $comment_id = isset( $activities_template->activity->current_comment->id )
             ? $activities_template->activity->current_comment->id
             : 0;
 
-        // Setup the comment link
+        // Setup the comment link.
         $comment_link = ! empty( $comment_id )
             ? '#acomment-' .$comment_id
             : false;
 
-        // Append comment ID to end of activity permalink
+        // Append comment ID to end of activity permalink.
         $link = bp_activity_get_permalink( $activities_template->activity->id, $activities_template->activity ) . $comment_link;
 
@@ -3141 +3144 @@
         $class = 'delete-activity';
 
-        // Determine if we're on a single activity page, and customize accordingly
+        // Determine if we're on a single activity page, and customize accordingly.
         if ( bp_is_activity_component() && is_numeric( bp_current_action() ) ) {
             $class = 'delete-activity-single';
@@ -3191 +3194 @@
         $url = trailingslashit( bp_get_root_domain() . '/' . bp_get_activity_root_slug() . '/delete/' . $activities_template->activity->id );
 
-        // Determine if we're on a single activity page, and customize accordingly
+        // Determine if we're on a single activity page, and customize accordingly.
         if ( bp_is_activity_component() && is_numeric( bp_current_action() ) ) {
             $url = add_query_arg( array( 'redirect_to' => wp_get_referer() ), $url );
@@ -3237 +3240 @@
      *
      * @param int $user_id If empty, will fall back on displayed user.
-     *
      * @return string|bool $latest_update The activity latest update link.
      *                                    False on failure.
@@ -3321 +3323 @@
         ) );
 
-        // Define local variable
+        // Define local variable.
         $component_links = array();
 
-        // Fetch the names of components that have activity recorded in the DB
+        // Fetch the names of components that have activity recorded in the DB.
         $components = BP_Activity_Activity::get_recorded_components();
 
@@ -3333 +3335 @@
         foreach ( (array) $components as $component ) {
 
-            // Skip the activity comment filter
+            // Skip the activity comment filter.
             if ( 'activity' == $component ) {
                 continue;
@@ -3411 +3413 @@
     $bp = buddypress();
 
-    // Assume activity can be commented on
+    // Assume activity can be commented on.
     $can_comment = true;
 
-    // Determine ability to comment based on activity action name
+    // Determine ability to comment based on activity action name.
     $activity_action = bp_get_activity_action_name();
 
@@ -3466 +3468 @@
 function bp_activity_can_comment_reply( $comment = false ) {
 
-    // Assume activity can be commented on
+    // Assume activity can be commented on.
     $can_comment = true;
 
-    // Check that comment exists
+    // Check that comment exists.
     if ( empty( $comment ) ) {
         $comment = bp_activity_current_comment();
@@ -3476 +3478 @@
     if ( ! empty( $comment ) ) {
 
-        // Fall back on current comment in activity loop
+        // Fall back on current comment in activity loop.
         $comment_depth = isset( $comment->depth )
             ? intval( $comment->depth )
             : bp_activity_get_comment_depth();
 
-        // Threading is turned on, so check the depth
+        // Threading is turned on, so check the depth.
         if ( get_option( 'thread_comments' ) ) {
             $can_comment = (bool) ( $comment_depth < get_option( 'thread_comments_depth' ) );
 
-        // No threading for comment replies if no threading for comments
+        // No threading for comment replies if no threading for comments.
         } else {
             $can_comment = false;
@@ -3548 +3550 @@
      *
      * @param int $user_id ID of user being queried. Default: displayed user ID.
-     *
      * @return int The total favorite count for the specified user.
      */
@@ -3555 +3556 @@
 
         if ( bp_activity_can_favorite() ) {
-            // Default to displayed user if none is passed
+            // Default to displayed user if none is passed.
             $user_id = empty( $user_id )
                 ? bp_displayed_user_id()
                 : $user_id;
 
-            // Get user meta if user ID exists
+            // Get user meta if user ID exists.
             if ( ! empty( $user_id ) ) {
                 $retval = bp_activity_total_favorites_for_user( $user_id );
@@ -3600 +3601 @@
      *
      * @param int $user_id ID of user being queried. Default: displayed user ID.
-     *
      * @return int The total mention count for the specified user.
      */
     function bp_get_total_mention_count_for_user( $user_id = 0 ) {
 
-        // Default to displayed user if none is passed
+        // Default to displayed user if none is passed.
         $user_id = empty( $user_id )
             ? bp_displayed_user_id()
             : $user_id;
 
-        // Get user meta if user ID exists
+        // Get user meta if user ID exists.
         $retval = ! empty( $user_id )
             ? bp_get_user_meta( $user_id, 'bp_new_mention_count', true )
@@ -3652 +3652 @@
     function bp_get_send_public_message_link() {
 
-        // No link if not logged in, not looking at someone else's profile
+        // No link if not logged in, not looking at someone else's profile.
         if ( ! is_user_logged_in() || ! bp_is_user() || bp_is_my_profile() ) {
             $retval = '';
@@ -3678 +3678 @@
  * @param array $activity Array of activities generated from {@link bp_activity_get()}.
  * @param array $activity_ids Used for recursion purposes in this function.
- *
  * @return array
  */
@@ -3721 +3720 @@
      * @uses apply_filters() To call the 'bp_get_mentioned_user_display_name' hook.
      *
-     * @param int|string|bool User ID or username.
-     *
+     * @param int|string|bool $user_id_or_username User ID or username.
      * @return string The mentioned user's display name.
      */
     function bp_get_mentioned_user_display_name( $user_id_or_username = false ) {
 
-        // Get user display name
+        // Get user display name.
         $name = bp_core_get_user_displayname( $user_id_or_username );
 
-        // If user somehow has no name, return this really lame string
+        // If user somehow has no name, return this really lame string.
         if ( empty( $name ) ) {
             $name = __( 'a user', 'buddypress' );
@@ -3868 +3866 @@
     ) );
 
-    // Get the user IDs of everyone who has left a comment to the current activity item
+    // Get the user IDs of everyone who has left a comment to the current activity item.
     $user_ids = bp_activity_get_comments_user_ids();
     $output   = array();
@@ -3876 +3874 @@
         foreach ( (array) $user_ids as $user_id ) {
 
-            // Skip an empty user ID
+            // Skip an empty user ID.
             if ( empty( $user_id ) ) {
                 continue;
             }
 
-            // Get profile link for this user
+            // Get profile link for this user.
             $profile_link = bp_core_get_user_domain( $user_id );
 
-            // Get avatar for this user
+            // Get avatar for this user.
             $image_html   = bp_core_fetch_avatar( array(
                 'item_id' => $user_id,
@@ -3893 +3891 @@
             ) );
 
-            // If user has link & avatar, add them to the output array
+            // If user has link & avatar, add them to the output array.
             if ( ! empty( $profile_link ) && ! empty( $image_html ) ) {
                 $output[] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $profile_link ), $image_html );
@@ -3899 +3897 @@
         }
 
-        // If output array is not empty, wrap everything in some list items
+        // If output array is not empty, wrap everything in some list items.
         if ( ! empty( $output ) ) {
             $retval = '<li>' . implode( '</li><li>', $output ) . '</li>';
@@ -3947 +3945 @@
      *
      * @param array $comments Array of {@link BP_Activity_Activity} items.
-     *
      * @return array Array of user IDs.
      */
     function bp_activity_recurse_comments_user_ids( array $comments = array() ) {
 
-        // Default user ID's array
+        // Default user ID's array.
         $user_ids = array();
 
-        // Loop through comments and try to get user ID's
+        // Loop through comments and try to get user ID's.
         if ( ! empty( $comments ) ) {
             foreach ( $comments as $comment ) {
@@ -3965 +3962 @@
                 }
 
-                // Add user ID to array
+                // Add user ID to array.
                 $user_ids[] = $comment->user_id;
 
-                // Check for commentception
+                // Check for commentception.
                 if ( ! empty( $comment->children ) ) {
                     $user_ids = array_merge( $user_ids, bp_activity_recurse_comments_user_ids( $comment->children ) );
@@ -4037 +4034 @@
     natsort( $activities );
 
-    // Loop through the activity types and output markup
+    // Loop through the activity types and output markup.
     foreach ( $activities as $type => $description ) {
 
-        // See if we need to preselect the current type
+        // See if we need to preselect the current type.
         $checked  = checked(  true, in_array( $type, (array) $args['selected'] ), false );
         $selected = selected( true, in_array( $type, (array) $args['selected'] ), false );
 
-        // Switch output based on the element
+        // Switch output based on the element.
         switch ( $output ) {
             case 'select' :
@@ -4069 +4066 @@
     }
 
-    // Backpat with BP-Default for dropdown boxes only
+    // Backpat with BP-Default for dropdown boxes only.
     if ( 'select' === $output ) {
         do_action( 'bp_activity_filter_options' );
@@ -4153 +4150 @@
     function bp_get_member_activity_feed_link() {
 
-        // Single member activity feed link
+        // Single member activity feed link.
         if ( bp_is_profile_component() || bp_is_current_action( 'just-me' ) ) {
             $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/feed/';
 
-        // Friend feed link
+        // Friend feed link.
         } elseif ( bp_is_active( 'friends' ) && bp_is_current_action( bp_get_friends_slug() ) ) {
             $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/' . bp_get_friends_slug() . '/feed/';
 
-        // Group feed link
+        // Group feed link.
         } elseif ( bp_is_active( 'groups'  ) && bp_is_current_action( bp_get_groups_slug()  ) ) {
             $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/' . bp_get_groups_slug() . '/feed/';
 
-        // Favorites activity feed link
+        // Favorites activity feed link.
         } elseif ( 'favorites' === bp_current_action() ) {
             $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/favorites/feed/';
 
-        // Mentions activity feed link
+        // Mentions activity feed link.
         } elseif ( ( 'mentions' === bp_current_action() ) && bp_activity_do_mentions() ) {
             $link = bp_displayed_user_domain() . bp_get_activity_slug() . '/mentions/feed/';
 
-        // No feed link
+        // No feed link.
         } else {
             $link = '';
@@ -4395 +4392 @@
         global $activities_template;
 
-        // Get the content, if exists
+        // Get the content, if exists.
         $content = ! empty( $activities_template->activity->content )
             ? $activities_template->activity->content
             : '';
 
-        // Perform a few string conversions on the content, if it's not empty
+        // Perform a few string conversions on the content, if it's not empty.
         if ( ! empty( $content ) ) {
             $content = ent2ncr( convert_chars( str_replace( '%s', '', $content ) ) );
@@ -4438 +4435 @@
  *
  * @param string $context The current context. 'activity', 'member',
- *                        'member_groups', 'group'.
+ *                        'member_groups', 'group'.
  * @uses bp_get_activity_show_filters()
  */
@@ -4450 +4447 @@
      *
      * @param string $context The current context. 'activity', 'member',
-     *                        'member_groups', 'group'.
+     *                        'member_groups', 'group'.
      *
      * @return string HTML for <option> values.
      */
     function bp_get_activity_show_filters( $context = '' ) {
-        // Set default context based on current page
+        // Set default context based on current page.
         if ( empty( $context ) ) {
 
             // On member pages, default to 'member', unless this
-            // is a user's Groups activity
+            // is a user's Groups activity.
             if ( bp_is_user() ) {
                 if ( bp_is_active( 'groups' ) && bp_is_current_action( bp_get_groups_slug() ) ) {
@@ -4467 +4464 @@
                 }
 
-            // On individual group pages, default to 'group'
+            // On individual group pages, default to 'group'.
             } elseif ( bp_is_active( 'groups' ) && bp_is_group() ) {
                 $context = 'group';
 
-            // 'activity' everywhere else
+            // 'activity' everywhere else.
             } else {
                 $context = 'activity';
@@ -4487 +4484 @@
                 }
 
-                // Friends activity collapses two filters into one
+                // Friends activity collapses two filters into one.
                 if ( in_array( $action['key'], array( 'friendship_accepted', 'friendship_created' ) ) ) {
                     $action['key'] = 'friendship_accepted,friendship_created';
@@ -4506 +4503 @@
         $filters = apply_filters( 'bp_get_activity_show_filters_options', $filters, $context );
 
-        // Build the options output
+        // Build the options output.
         $output = '';
 

trunk/src/bp-activity/classes/class-bp-activity-activity.php

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -164 +164 @@
         }
 
-        // Generate dynamic 'action' when possible
+        // Generate dynamic 'action' when possible.
         $action = bp_activity_generate_action_string( $this );
         if ( false !== $action ) {
@@ -170 +170 @@
 
         // If no callback is available, use the literal string from
-        // the database row
+        // the database row.
         } elseif ( ! empty( $row->action ) ) {
             $this->action = $row->action;
 
-        // Provide a fallback to avoid PHP notices
+        // Provide a fallback to avoid PHP notices.
         } else {
             $this->action = '';
@@ -235 +235 @@
         }
 
-        // If this is a new activity item, set the $id property
+        // If this is a new activity item, set the $id property.
         if ( empty( $this->id ) ) {
             $this->id = $wpdb->insert_id;
@@ -271 +271 @@
      * @param array $args {
      *     An array of arguments. All items are optional.
-     *
      *     @type int          $page              Which page of results to fetch. Using page=1 without per_page will result
      *                                           in no pagination. Default: 1.
@@ -296 +295 @@
      * }
      * @return array The array returned has two keys:
-     *     - 'total' is the count of located activities
-     *     - 'activities' is an array of the located activities
+     *               - 'total' is the count of located activities
+     *               - 'activities' is an array of the located activities
      */
     public static function get( $args = array() ) {
         global $wpdb;
 
-        // Backward compatibility with old method of passing arguments
+        // Backward compatibility with old method of passing arguments.
         if ( !is_array( $args ) || func_num_args() > 1 ) {
             _deprecated_argument( __METHOD__, '1.6', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ), __METHOD__, __FILE__ ) );
@@ -326 +325 @@
         $bp = buddypress();
         $r  = wp_parse_args( $args, array(
-            'page'              => 1,          // The current page
-            'per_page'          => 25,         // Activity items per page
-            'max'               => false,      // Max number of items to return
-            'fields'            => 'all',
-            'sort'              => 'DESC',     // ASC or DESC
-            'exclude'           => false,      // Array of ids to exclude
-            'in'                => false,      // Array of ids to limit query by (IN)
-            'meta_query'        => false,      // Filter by activitymeta
-            'date_query'        => false,      // Filter by date
-            'filter_query'      => false,      // Advanced filtering - see BP_Activity_Query
-            'filter'            => false,      // See self::get_filter_sql()
-            'scope'             => false,      // Preset activity arguments
-            'search_terms'      => false,      // Terms to search by
-            'display_comments'  => false,      // Whether to include activity comments
-            'show_hidden'       => false,      // Show items marked hide_sitewide
-            'spam'              => 'ham_only', // Spam status
-            'update_meta_cache' => true,
-            'count_total'       => false,
+            'page'              => 1,          // The current page.
+            'per_page'          => 25,         // Activity items per page.
+            'max'               => false,      // Max number of items to return.
+            'fields'            => 'all',      // Fields to include.
+            'sort'              => 'DESC',     // ASC or DESC.
+            'exclude'           => false,      // Array of ids to exclude.
+            'in'                => false,      // Array of ids to limit query by (IN).
+            'meta_query'        => false,      // Filter by activitymeta.
+            'date_query'        => false,      // Filter by date.
+            'filter_query'      => false,      // Advanced filtering - see BP_Activity_Query.
+            'filter'            => false,      // See self::get_filter_sql().
+            'scope'             => false,      // Preset activity arguments.
+            'search_terms'      => false,      // Terms to search by.
+            'display_comments'  => false,      // Whether to include activity comments.
+            'show_hidden'       => false,      // Show items marked hide_sitewide.
+            'spam'              => 'ham_only', // Spam status.
+            'update_meta_cache' => true,       // Whether or not to update meta cache.
+            'count_total'       => false,      // Whether or not to use count_total.
         ) );
 
-        // Select conditions
+        // Select conditions.
         $select_sql = "SELECT DISTINCT a.id";
 
@@ -353 +352 @@
         $join_sql   = '';
 
-        // Where conditions
+        // Where conditions.
         $where_conditions = array();
 
-        // Excluded types
+        // Excluded types.
         $excluded_types = array();
 
-        // Scope takes precedence
+        // Scope takes precedence.
         if ( ! empty( $r['scope'] ) ) {
             $scope_query = self::get_scope_query_sql( $r['scope'], $r );
 
-            // Add our SQL conditions if matches were found
+            // Add our SQL conditions if matches were found.
             if ( ! empty( $scope_query['sql'] ) ) {
                 $where_conditions['scope_query_sql'] = $scope_query['sql'];
             }
 
-            // override some arguments if needed
+            // Override some arguments if needed.
             if ( ! empty( $scope_query['override'] ) ) {
                 $r = self::array_replace_recursive( $r, $scope_query['override'] );
             }
 
-        // Advanced filtering
+        // Advanced filtering.
         } elseif ( ! empty( $r['filter_query'] ) ) {
             $filter_query = new BP_Activity_Query( $r['filter_query'] );
@@ -382 +381 @@
         }
 
-        // Regular filtering
+        // Regular filtering.
         if ( $r['filter'] && $filter_sql = BP_Activity_Activity::get_filter_sql( $r['filter'] ) ) {
             $where_conditions['filter_sql'] = $filter_sql;
         }
 
-        // Spam
+        // Spam.
         if ( 'ham_only' == $r['spam'] ) {
             $where_conditions['spam_sql'] = 'a.is_spam = 0';
@@ -394 +393 @@
         }
 
-        // Searching
+        // Searching.
         if ( $r['search_terms'] ) {
             $search_terms_like = '%' . bp_esc_like( $r['search_terms'] ) . '%';
@@ -400 +399 @@
         }
 
-        // Sorting
+        // Sorting.
         $sort = $r['sort'];
         if ( $sort != 'ASC' && $sort != 'DESC' ) {
@@ -411 +410 @@
         }
 
-        // Exclude specified items
+        // Exclude specified items.
         if ( ! empty( $r['exclude'] ) ) {
             $exclude = implode( ',', wp_parse_id_list( $r['exclude'] ) );
@@ -417 +416 @@
         }
 
-        // The specific ids to which you want to limit the query
+        // The specific ids to which you want to limit the query.
         if ( ! empty( $r['in'] ) ) {
             $in = implode( ',', wp_parse_id_list( $r['in'] ) );
@@ -423 +422 @@
         }
 
-        // Process meta_query into SQL
+        // Process meta_query into SQL.
         $meta_query_sql = self::get_meta_query_sql( $r['meta_query'] );
 
@@ -434 +433 @@
         }
 
-        // Process date_query into SQL
+        // Process date_query into SQL.
         $date_query_sql = self::get_date_query_sql( $r['date_query'] );
 
@@ -449 +448 @@
 
         // Exclude 'last_activity' items unless the 'action' filter has
-        // been explicitly set
+        // been explicitly set.
         if ( empty( $r['filter']['object'] ) ) {
             $excluded_types[] = 'last_activity';
         }
 
-        // Build the excluded type sql part
+        // Build the excluded type sql part.
         if ( ! empty( $excluded_types ) ) {
             $not_in = "'" . implode( "', '", esc_sql( $excluded_types ) ) . "'";
@@ -473 +472 @@
         $where_conditions = apply_filters( 'bp_activity_get_where_conditions', $where_conditions, $r, $select_sql, $from_sql, $join_sql );
 
-        // Join the where conditions together
+        // Join the where conditions together.
         $where_sql = 'WHERE ' . join( ' AND ', $where_conditions );
 
@@ -488 +487 @@
             if ( false !== strpos( $where_sql, $index ) ) {
                 $the_index = $index;
-                break; // Take the first one we find
+                break; // Take the first one we find.
             }
         }
@@ -498 +497 @@
         }
 
-        // Sanitize page and per_page parameters
+        // Sanitize page and per_page parameters.
         $page     = absint( $r['page']     );
         $per_page = absint( $r['per_page'] );
@@ -521 +520 @@
         if ( apply_filters( 'bp_use_legacy_activity_query', false, __METHOD__, $r ) ) {
 
-            // Legacy queries joined against the user table
+            // Legacy queries joined against the user table.
             $select_sql = "SELECT DISTINCT a.*, u.user_email, u.user_nicename, u.user_login, u.display_name";
             $from_sql   = " FROM {$bp->activity->table_name} a LEFT JOIN {$wpdb->users} u ON a.user_id = u.ID";
@@ -528 +527 @@
                 $pag_sql    = $wpdb->prepare( "LIMIT %d, %d", absint( ( $page - 1 ) * $per_page ), $per_page );
 
-                /** this filter is documented in bp-activity/bp-activity-classes.php */
+                /** This filter is documented in bp-activity/bp-activity-classes.php */
                 $activities = $wpdb->get_results( apply_filters( 'bp_activity_get_user_join_filter', "{$select_sql} {$from_sql} {$join_sql} {$where_sql} ORDER BY a.date_recorded {$sort} {$pag_sql}", $select_sql, $from_sql, $where_sql, $sort, $pag_sql ) );
             } else {
@@ -548 +547 @@
 
         } else {
-            // Query first for activity IDs
+            // Query first for activity IDs.
             $activity_ids_sql = "{$select_sql} {$from_sql} {$join_sql} {$where_sql} ORDER BY a.date_recorded {$sort}";
 
             if ( ! empty( $per_page ) && ! empty( $page ) ) {
                 // We query for $per_page + 1 items in order to
-                // populate the has_more_items flag
+                // populate the has_more_items flag.
                 $activity_ids_sql .= $wpdb->prepare( " LIMIT %d, %d", absint( ( $page - 1 ) * $per_page ), $per_page + 1 );
             }
@@ -572 +571 @@
 
             // If we've fetched more than the $per_page value, we
-            // can discard the extra now
+            // can discard the extra now.
             if ( ! empty( $per_page ) && count( $activity_ids ) === $per_page + 1 ) {
                 array_pop( $activity_ids );
@@ -585 +584 @@
 
         if ( 'ids' !== $r['fields'] ) {
-            // Get the fullnames of users so we don't have to query in the loop
+            // Get the fullnames of users so we don't have to query in the loop.
             $activities = self::append_user_fullnames( $activities );
 
-            // Get activity meta
+            // Get activity meta.
             $activity_ids = array();
             foreach ( (array) $activities as $activity ) {
@@ -602 +601 @@
             }
 
-            // Pre-fetch data associated with activity users and other objects
+            // Pre-fetch data associated with activity users and other objects.
             BP_Activity_Activity::prefetch_object_data( $activities );
 
-            // Generate action strings
+            // Generate action strings.
             $activities = BP_Activity_Activity::generate_action_strings( $activities );
         }
@@ -611 +610 @@
         $retval['activities'] = $activities;
 
-        // If $max is set, only return up to the max results
+        // If $max is set, only return up to the max results.
         if ( ! empty( $r['count_total'] ) ) {
 
@@ -644 +643 @@
      *
      * @param array $activity_ids Array of activity IDs.
-     *
      * @return array
      */
@@ -650 +648 @@
         global $wpdb;
 
-        // Bail if no activity ID's passed
+        // Bail if no activity ID's passed.
         if ( empty( $activity_ids ) ) {
             return array();
         }
 
-        // Get BuddyPress
+        // Get BuddyPress.
         $bp = buddypress();
 
@@ -661 +659 @@
         $uncached_ids = bp_get_non_cached_ids( $activity_ids, 'bp_activity' );
 
-        // Prime caches as necessary
+        // Prime caches as necessary.
         if ( ! empty( $uncached_ids ) ) {
-            // Format the activity ID's for use in the query below
+            // Format the activity ID's for use in the query below.
             $uncached_ids_sql = implode( ',', wp_parse_id_list( $uncached_ids ) );
 
-            // Fetch data from activity table, preserving order
+            // Fetch data from activity table, preserving order.
             $queried_adata = $wpdb->get_results( "SELECT * FROM {$bp->activity->table_name} WHERE id IN ({$uncached_ids_sql})");
 
             // Put that data into the placeholders created earlier,
-            // and add it to the cache
+            // and add it to the cache.
             foreach ( (array) $queried_adata as $adata ) {
                 wp_cache_set( $adata->id, $adata, 'bp_activity' );
@@ -676 +674 @@
         }
 
-        // Now fetch data from the cache
+        // Now fetch data from the cache.
         foreach ( $activity_ids as $activity_id ) {
             $activities[] = wp_cache_get( $activity_id, 'bp_activity' );
         }
 
-        // Then fetch user data
+        // Then fetch user data.
         $user_query = new BP_User_Query( array(
             'user_ids'        => wp_list_pluck( $activities, 'user_id' ),
@@ -687 +685 @@
         ) );
 
-        // Associated located user data with activity items
+        // Associated located user data with activity items.
         foreach ( $activities as $a_index => $a_item ) {
             $a_user_id = intval( $a_item->user_id );
@@ -709 +707 @@
      *
      * @param array $activities Activities array.
-     *
      * @return array
      */
@@ -750 +747 @@
      *
      * @param array $activities Array of activities.
-     *
      * @return array $activities Array of activities.
      */
@@ -776 +772 @@
      *
      * @param array $activities Array of activities.
-     *
      * @return array
      */
@@ -805 +800 @@
      * @param array $meta_query An array of meta_query filters. See the
      *                          documentation for WP_Meta_Query for details.
-     *
      * @return array $sql_array 'join' and 'where' clauses.
      */
@@ -820 +814 @@
 
             // WP_Meta_Query expects the table name at
-            // $wpdb->activitymeta
+            // $wpdb->activitymeta.
             $wpdb->activitymeta = buddypress()->activity->table_name_meta;