Changeset 10374

Timestamp:

11/23/2015 03:55:00 AM (11 years ago)

Author:

tw2113

Message:

More documentation cleanup for BP-Blogs component.

See #6397.

Location:

trunk/src/bp-blogs

Files:

• bp-blogs-actions.php (modified) (2 diffs)
• bp-blogs-activity.php (modified) (51 diffs)
• bp-blogs-cache.php (modified) (1 diff)
• bp-blogs-filters.php (modified) (3 diffs)
• bp-blogs-functions.php (modified) (57 diffs)
• bp-blogs-loader.php (modified) (18 diffs)
• bp-blogs-screens.php (modified) (8 diffs)
• bp-blogs-template.php (modified) (29 diffs)
• bp-blogs-widgets.php (modified) (4 diffs)
• classes/class-bp-blogs-blog.php (modified) (18 diffs)

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -17 +17 @@
 function bp_blogs_redirect_to_random_blog() {
 
-        // Bail if not looking for a random blog
+        // Bail if not looking for a random blog.
         if ( ! bp_is_blogs_component() || ! isset( $_GET['random-blog'] ) )
                 return;
 
-        // Multisite is active so find a random blog
+        // Multisite is active so find a random blog.
         if ( is_multisite() ) {
                 $blog = bp_blogs_get_random_blogs( 1, 1 );
                 bp_core_redirect( get_home_url( $blog['blogs'][0]->blog_id ) );
 
-        // No multisite and still called, always redirect to root
+        // No multisite and still called, always redirect to root.
         } else {
                 bp_core_redirect( bp_core_get_root_domain() );

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

@@ -20 +20 @@
         $bp = buddypress();
 
-        // Bail if activity is not active
+        // Bail if activity is not active.
         if ( ! bp_is_active( 'activity' ) ) {
                 return false;
@@ -37 +37 @@
         }
 
-        // Only add the comment type if the 'post' post type is trackable
+        // Only add the comment type if the 'post' post type is trackable.
         if ( post_type_supports( 'post', 'buddypress-activity' ) ) {
                 bp_activity_set_action(
@@ -66 +66 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity data object.
- *
  * @return string
  */
@@ -75 +74 @@
         $action = sprintf( __( '%s created the site %s', 'buddypress' ), bp_core_get_userlink( $activity->user_id ), '<a href="' . esc_url( $blog_url ) . '">' . esc_html( $blog_name ) . '</a>' );
 
-        // Legacy filter - requires the BP_Blogs_Blog object
+        // Legacy filter - requires the BP_Blogs_Blog object.
         if ( has_filter( 'bp_blogs_activity_created_blog_action' ) ) {
                 $user_blog = BP_Blogs_Blog::get_user_blog( $activity->user_id, $activity->item_id );
@@ -105 +104 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity data object.
- *
  * @return string Constructed activity action.
  */
@@ -141 +139 @@
         }
 
-        // Should be the case when the post has just been published
+        // Should be the case when the post has just been published.
         if ( isset( $activity->post_title ) ) {
                 $post_title = $activity->post_title;
 
-        // If activity already exists try to get the post title from activity meta
+        // If activity already exists try to get the post title from activity meta.
         } else if ( ! empty( $activity->id ) ) {
                 $post_title = bp_activity_get_meta( $activity->id, 'post_title' );
@@ -152 +150 @@
         /**
          * In case the post was published without a title
-         * or the activity meta was not found
+         * or the activity meta was not found.
          */
         if ( empty( $post_title ) ) {
-                // Defaults to no title
+                // Defaults to no title.
                 $post_title = esc_html__( '(no title)', 'buddypress' );
 
@@ -167 +165 @@
                         }
 
-                        // Make sure the activity exists before saving the post title in activity meta
+                        // Make sure the activity exists before saving the post title in activity meta.
                         if ( ! empty( $activity->id ) ) {
                                 bp_activity_update_meta( $activity->id, 'post_title', $post_title );
@@ -176 +174 @@
         }
 
-        // Build the 'post link' part of the activity action string
+        // Build the 'post link' part of the activity action string.
         $post_link  = '<a href="' . esc_url( $post_url ) . '">' . $post_title . '</a>';
 
         $user_link = bp_core_get_userlink( $activity->user_id );
 
-        // Build the complete activity action string
+        // Build the complete activity action string.
         if ( is_multisite() ) {
                 $action  = sprintf( __( '%1$s wrote a new post, %2$s, on the site %3$s', 'buddypress' ), $user_link, $post_link, '<a href="' . esc_url( $blog_url ) . '">' . esc_html( $blog_name ) . '</a>' );
@@ -188 +186 @@
         }
 
-        // Legacy filter - requires the post object
+        // Legacy filter - requires the post object.
         if ( has_filter( 'bp_blogs_activity_new_post_action' ) ) {
                 switch_to_blog( $activity->item_id );
@@ -217 +215 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity data object.
- *
  * @return string Constructed activity action.
  */
@@ -235 +232 @@
         $post_title = bp_activity_get_meta( $activity->id, 'post_title' );
 
-        // Should only be empty at the time of post creation
+        // Should only be empty at the time of post creation.
         if ( empty( $post_url ) || empty( $post_title ) ) {
                 switch_to_blog( $activity->item_id );
@@ -265 +262 @@
         }
 
-        // Legacy filter - requires the comment object
+        // Legacy filter - requires the comment object.
         if ( has_filter( 'bp_blogs_activity_new_comment_action' ) ) {
                 switch_to_blog( $activity->item_id );
@@ -295 +292 @@
  *
  * @param array $activities Array of activity items.
- *
  * @return array
  */
@@ -338 +334 @@
 function bp_blogs_record_activity( $args = '' ) {
 
-        // Bail if activity is not active
+        // Bail if activity is not active.
         if ( ! bp_is_active( 'activity' ) ) {
                 return false;
@@ -415 +411 @@
 function bp_blogs_delete_activity( $args = '' ) {
 
-        // Bail if activity is not active
+        // Bail if activity is not active.
         if ( ! bp_is_active( 'activity' ) ) {
                 return false;
@@ -444 +440 @@
  * @since 2.0.0
  *
- * @param object $activity The BP_Activity_Activity object
- *
+ * @param object $activity The BP_Activity_Activity object.
  * @return bool
  */
@@ -453 +448 @@
         $blog_id = $activity->item_id;
 
-        // see if we've mirrored the close comments option before
+        // See if we've mirrored the close comments option before.
         $days_old = bp_blogs_get_blogmeta( $blog_id, 'close_comments_days_old' );
 
-        // we've never cached these items before, so do it now
+        // We've never cached these items before, so do it now.
         if ( '' === $days_old ) {
                 switch_to_blog( $blog_id );
 
-                // use comments_open()
+                // Use comments_open().
                 remove_filter( 'comments_open', 'bp_comments_open', 10, 2 );
                 $open = comments_open( $activity->secondary_item_id );
                 add_filter( 'comments_open', 'bp_comments_open', 10, 2 );
 
-                // might as well mirror values to blogmeta since we're here!
+                // Might as well mirror values to blogmeta since we're here!
                 $thread_depth = get_option( 'thread_comments' );
                 if ( ! empty( $thread_depth ) ) {
                         $thread_depth = get_option( 'thread_comments_depth' );
                 } else {
-                        // perhaps filter this?
+                        // Perhaps filter this?
                         $thread_depth = 1;
                 }
@@ -480 +475 @@
                 restore_current_blog();
 
-        // check blogmeta and manually check activity item
-        // basically a copy of _close_comments_for_old_post()
+        // Check blogmeta and manually check activity item.
+        // Basically a copy of _close_comments_for_old_post().
         } else {
 
-                // comments are closed
+                // Comments are closed.
                 if ( 'closed' == bp_activity_get_meta( $activity->id, 'post_comment_status' ) ) {
                         return false;
@@ -498 +493 @@
                 }
 
-                /* commenting out for now - needs some more thought...
+                /*
+                   Commenting out for now - needs some more thought...
                    should we add the post type to activity meta?
 
@@ -535 +531 @@
  */
 function bp_blogs_sync_add_from_activity_comment( $comment_id, $params, $parent_activity ) {
-        // if parent activity isn't a blog post, stop now!
+        // If parent activity isn't a blog post, stop now!
         if ( $parent_activity->type != 'new_blog_post' ) {
                 return;
         }
 
-        // if activity comments are disabled for blog posts, stop now!
+        // If activity comments are disabled for blog posts, stop now!
         if ( bp_disable_blogforum_comments() ) {
                 return;
         }
 
-        // get userdata
+        // Get userdata.
         if ( $params['user_id'] == bp_loggedin_user_id() ) {
                 $user = buddypress()->loggedin_user->userdata;
@@ -552 +548 @@
         }
 
-        // see if a parent WP comment ID exists
+        // See if a parent WP comment ID exists.
         if ( ! empty( $params['parent_id'] ) ) {
                 $comment_parent = bp_activity_get_meta( $params['parent_id'], 'bp_blogs_post_comment_id' );
@@ -559 +555 @@
         }
 
-        // comment args
+        // Comment args.
         $args = array(
                 'comment_post_ID'      => $parent_activity->secondary_item_id,
@@ -566 +562 @@
                 'comment_author_url'   => bp_core_get_user_domain( $params['user_id'], $user->user_nicename, $user->user_login ),
                 'comment_content'      => $params['content'],
-                'comment_type'         => '', // could be interesting to add 'buddypress' here...
+                'comment_type'         => '', // Could be interesting to add 'buddypress' here...
                 'comment_parent'       => (int) $comment_parent,
                 'user_id'              => $params['user_id'],
 
-                // commenting these out for now
-                //'comment_author_IP'    => '127.0.0.1',
-                //'comment_agent'        => '',
-
+                // Commenting these out for now
+                // 'comment_author_IP'    => '127.0.0.1',
+                // 'comment_agent'        => '', .
                 'comment_approved'     => 1
         );
 
-        // prevent separate activity entry being made
+        // Prevent separate activity entry being made.
         remove_action( 'comment_post', 'bp_blogs_record_comment', 10, 2 );
 
-        // handle multisite
+        // Handle multisite.
         switch_to_blog( $parent_activity->item_id );
 
-        // handle timestamps for the WP comment after we've switched to the blog
+        // Handle timestamps for the WP comment after we've switched to the blog.
         $args['comment_date']     = current_time( 'mysql' );
         $args['comment_date_gmt'] = current_time( 'mysql', 1 );
 
-        // post the comment
+        // Post the comment.
         $post_comment_id = wp_insert_comment( $args );
 
-        // add meta to comment
+        // Add meta to comment.
         add_comment_meta( $post_comment_id, 'bp_activity_comment_id', $comment_id );
 
-        // add meta to activity comment
+        // Add meta to activity comment.
         bp_activity_update_meta( $comment_id, 'bp_blogs_post_comment_id', $post_comment_id );
 
-        // resave activity comment with WP comment permalink
+        // Resave activity comment with WP comment permalink.
         //
         // in bp_blogs_activity_comment_permalink(), we change activity comment
@@ -602 +597 @@
         //
         // @todo since this is done after AJAX posting, the activity comment permalink
-        //       doesn't change on the frontend until the next page refresh.
+        // doesn't change on the frontend until the next page refresh.
         $resave_activity = new BP_Activity_Activity( $comment_id );
         $resave_activity->primary_link = get_comment_link( $post_comment_id );
@@ -614 +609 @@
         $resave_activity->save();
 
-        // add the edit activity comment hook back
+        // Add the edit activity comment hook back.
         add_action( 'bp_activity_before_save', 'bp_blogs_sync_activity_edit_to_post_comment', 20 );
 
-        // multisite again!
+        // Multisite again!
         restore_current_blog();
 
-        // add the comment hook back
+        // Add the comment hook back.
         add_action( 'comment_post', 'bp_blogs_record_comment', 10, 2 );
 
@@ -646 +641 @@
  * @since 2.0.0
  *
- * @param bool $retval
+ * @param bool $retval             Whether BuddyPress should continue or not.
  * @param int  $parent_activity_id The parent activity ID for the activity comment.
  * @param int  $activity_id        The activity ID for the pending deleted activity comment.
- *
  * @return bool
  */
 function bp_blogs_sync_delete_from_activity_comment( $retval, $parent_activity_id, $activity_id ) {
-        // check if parent activity is a blog post
+        // Check if parent activity is a blog post.
         $parent_activity = new BP_Activity_Activity( $parent_activity_id );
         if ( 'new_blog_post' != $parent_activity->type ) {
@@ -659 +653 @@
         }
 
-        // fetch the activity comments for the activity item
+        // Fetch the activity comments for the activity item.
         $activity = bp_activity_get( array(
                 'in'               => $activity_id,
@@ -665 +659 @@
         ) );
 
-        // get all activity comment IDs for the pending deleted item
+        // Get all activity comment IDs for the pending deleted item.
         $activity_ids   = bp_activity_recurse_comments_activity_ids( $activity );
         $activity_ids[] = $activity_id;
 
-        // handle multisite
-        // switch to the blog where the comment was made
+        // Handle multisite
+        // switch to the blog where the comment was made.
         switch_to_blog( $parent_activity->item_id );
 
-        // remove associated blog comments
+        // Remove associated blog comments.
         bp_blogs_remove_associated_blog_comments( $activity_ids, current_user_can( 'moderate_comments' ) );
 
-        // multisite again!
+        // Multisite again!
         restore_current_blog();
 
-        // rebuild activity comment tree
-        // emulate bp_activity_delete_comment()
+        // Rebuild activity comment tree
+        // emulate bp_activity_delete_comment().
         BP_Activity_Activity::rebuild_activity_comment_tree( $parent_activity_id );
 
-        // we're overriding the default bp_activity_delete_comment() functionality
-        // so we need to return false
+        // We're overriding the default bp_activity_delete_comment() functionality
+        // so we need to return false.
         return false;
 }
@@ -697 +691 @@
  */
 function bp_blogs_sync_activity_edit_to_post_comment( BP_Activity_Activity $activity ) {
-        // not an activity comment? stop now!
+        // Not an activity comment? stop now!
         if ( 'activity_comment' !== $activity->type ) {
                 return;
         }
 
-        // this is a new entry, so stop!
-        // we only want edits!
+        // This is a new entry, so stop!
+        // We only want edits!
         if ( empty( $activity->id ) ) {
                 return;
         }
 
-        // prevent recursion
+        // Prevent recursion.
         remove_action( 'bp_activity_before_save', 'bp_blogs_sync_activity_edit_to_post_comment', 20 );
 
-        // Try to see if a corresponding blog comment exists
+        // Try to see if a corresponding blog comment exists.
         $post_comment_id = bp_activity_get_meta( $activity->id, 'bp_blogs_post_comment_id' );
 
@@ -718 +712 @@
         }
 
-        // fetch parent activity item
+        // Fetch parent activity item.
         $parent_activity = new BP_Activity_Activity( $activity->item_id );
 
-        // sanity check
+        // Sanity check.
         if ( 'new_blog_post' !== $parent_activity->type ) {
                 return;
         }
 
-        // handle multisite
+        // Handle multisite.
         switch_to_blog( $parent_activity->item_id );
 
-        // update the blog post comment
+        // Update the blog post comment.
         wp_update_comment( array(
                 'comment_ID'      => $post_comment_id,
@@ -783 +777 @@
  *
  * @param array $args Arguments passed from bp_parse_args() in bp_has_activities().
- *
  * @return array $args
  */
@@ -790 +783 @@
         $bp = buddypress();
 
-        // Bail if this is not a 'new_blog_comment' query
+        // Bail if this is not a 'new_blog_comment' query.
         if ( 'new_blog_comment' !== $args['action'] ) {
                 return $args;
@@ -802 +795 @@
         }
 
-        // Init the filter query
+        // Init the filter query.
         $filter_query = array();
 
@@ -833 +826 @@
         $args['filter_query'] = $filter_query;
 
-        // Make sure to have comment in stream mode && avoid duplicate content
+        // Make sure to have comment in stream mode && avoid duplicate content.
         $args['display_comments'] = 'stream';
 
-        // Finally reset the action
+        // Finally reset the action.
         $args['action'] = '';
 
-        // Return the original arguments
+        // Return the original arguments.
         return $args;
 }
@@ -864 +857 @@
         }
 
-        // parent not a blog post? stop now!
+        // Parent not a blog post? stop now!
         if ( 'new_blog_post' !== $activity->type ) {
                 return;
@@ -873 +866 @@
         }
 
-        // if we've already done this before, stop now!
+        // If we've already done this before, stop now!
         if ( isset( buddypress()->blogs->allow_comments[ $activity->id ] ) ) {
                 return;
@@ -881 +874 @@
         $thread_depth   = bp_blogs_get_blogmeta( $activity->item_id, 'thread_comments_depth' );
 
-        // initialize a local object so we won't have to query this again in the
-        // comment loop
+        // Initialize a local object so we won't have to query this again in the
+        // comment loop.
         if ( empty( buddypress()->blogs->allow_comments ) ) {
                 buddypress()->blogs->allow_comments = array();
@@ -890 +883 @@
         }
 
-        // cache comment settings in the buddypress() singleton to reference later in
+        // Cache comment settings in the buddypress() singleton to reference later in
         // the activity comment loop
         // @see bp_blogs_disable_activity_replies()
@@ -909 +902 @@
  */
 function bp_blogs_setup_comment_loop_globals_on_ajax() {
-        // not AJAX? stop now!
+        // Not AJAX? stop now!
         if ( ! defined( 'DOING_AJAX' ) ) {
                 return;
@@ -917 +910 @@
         }
 
-        // get the parent activity item
+        // Get the parent activity item.
         $comment         = bp_activity_current_comment();
         $parent_activity = new BP_Activity_Activity( $comment->item_id );
 
-        // setup the globals
+        // Setup the globals.
         bp_blogs_setup_activity_loop_globals( $parent_activity );
 }
@@ -938 +931 @@
  * @since 2.0.0
  *
- * @param bool $retval Is activity commenting enabled for this activity entry?
- *
+ * @param bool $retval Is activity commenting enabled for this activity entry.
  * @return bool
  */
 function bp_blogs_disable_activity_commenting( $retval ) {
-        // if activity commenting is disabled, return current value
+        // If activity commenting is disabled, return current value.
         if ( bp_disable_blogforum_comments() ) {
                 return $retval;
         }
 
-        // activity commenting is enabled for blog posts
+        // Activity commenting is enabled for blog posts.
         switch ( bp_get_activity_action_name() ) {
 
-                // we still have to disable activity commenting for 'new_blog_comment' items
-                // commenting should only be done on the parent 'new_blog_post' item
+                // We still have to disable activity commenting for 'new_blog_comment' items
+                // commenting should only be done on the parent 'new_blog_post' item.
                 case 'new_blog_comment' :
                         $retval = false;
@@ -958 +950 @@
                         break;
 
-                // check if commenting is disabled for the WP blog post
-                // we should extrapolate this and automate this for plugins... or not
+                // Check if commenting is disabled for the WP blog post
+                // we should extrapolate this and automate this for plugins... or not.
                 case 'new_blog_post' :
                         global $activities_template;
 
-                        // setup some globals we'll need to reference later
+                        // Setup some globals we'll need to reference later.
                         bp_blogs_setup_activity_loop_globals( $activities_template->activity );
 
-                        // if comments are closed for the WP blog post, we should disable
-                        // activity comments for this activity entry
+                        // If comments are closed for the WP blog post, we should disable
+                        // activity comments for this activity entry.
                         if ( empty( buddypress()->blogs->allow_comments[bp_get_activity_id()] ) ) {
                                 $retval = false;
@@ -990 +982 @@
  * @since 2.0.0
  *
- * @param bool         $retval  Are replies allowed for this activity reply?
+ * @param bool         $retval  Are replies allowed for this activity reply.
  * @param object|array $comment The activity comment object.
  *
@@ -1000 +992 @@
         }
 
-        // check comment depth and disable if depth is too large
+        // Check comment depth and disable if depth is too large.
         if ( isset( buddypress()->blogs->thread_depth[$comment->item_id] ) ){
                 if ( $comment->mptt_left > buddypress()->blogs->thread_depth[$comment->item_id] ) {
@@ -1007 +999 @@
         }
 
-        // check if we should disable activity replies based on the parent activity
+        // Check if we should disable activity replies based on the parent activity.
         if ( isset( buddypress()->blogs->allow_comments[$comment->item_id] ) ){
-                // the blog post has closed off commenting, so we should disable all activity
-                // comments under the parent 'new_blog_post' activity entry
+                // The blog post has closed off commenting, so we should disable all activity
+                // comments under the parent 'new_blog_post' activity entry.
                 if ( empty( buddypress()->blogs->allow_comments[$comment->item_id] ) ) {
                         $retval = false;
@@ -1030 +1022 @@
  *
  * @param string $retval The activity comment permalink.
- *
  * @return string
  */
@@ -1036 +1027 @@
         global $activities_template;
 
-        // Get the current comment ID
+        // Get the current comment ID.
         $item_id = isset( $activities_template->activity->current_comment->item_id )
                 ? $activities_template->activity->current_comment->item_id
                 : false;
 
-        // Maybe adjust the link if item ID exists
+        // Maybe adjust the link if item ID exists.
         if ( ( false !== $item_id ) && isset( buddypress()->blogs->allow_comments[ $item_id ] ) ) {
                 $retval = $activities_template->activity->current_comment->primary_link;
@@ -1058 +1049 @@
  *
  * @param string               $retval   The activity permalink.
- * @param BP_Activity_Activity $activity
- *
+ * @param BP_Activity_Activity $activity Activity object.
  * @return string
  */
@@ -1085 +1075 @@
  *
  * @param string               $retval   The activity action.
- * @param BP_Activity_Activity $activity
- *
+ * @param BP_Activity_Activity $activity Activity object.
  * @return string
  */
@@ -1097 +1086 @@
 
         if ( ! empty( $blog_comment_id ) ) {
-                // fetch the parent blog post activity item
+                // Fetch the parent blog post activity item.
                 $parent_blog_post_activity = new BP_Activity_Activity( $activity->item_id );
 
-                // fake a 'new_blog_comment' activity object
+                // Fake a 'new_blog_comment' activity object.
                 $object = $activity;
 
-                // override 'item_id' to use blog ID
+                // Override 'item_id' to use blog ID.
                 $object->item_id = $parent_blog_post_activity->item_id;
 
-                // override 'secondary_item_id' to use comment ID
+                // Override 'secondary_item_id' to use comment ID.
                 $object->secondary_item_id = $blog_comment_id;
 
-                // now format the activity action using the 'new_blog_comment' action callback
+                // Now format the activity action using the 'new_blog_comment' action callback.
                 $retval = bp_blogs_format_activity_action_new_blog_comment( '', $object );
         }

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

@@ -25 +25 @@
 function bp_blogs_update_meta_cache( $blog_ids = false ) {
         $cache_args = array(
-                'object_ids'       => $blog_ids,
-                'object_type'      => buddypress()->blogs->id,
-                'object_column'    => 'blog_id',
-                'cache_group'      => 'blog_meta',
-                'meta_table'       => buddypress()->blogs->table_name_blogmeta,
+                'object_ids'    => $blog_ids,
+                'object_type'   => buddypress()->blogs->id,
+                'object_column' => 'blog_id',
+                'cache_group'   => 'blog_meta',
+                'meta_table'    => buddypress()->blogs->table_name_blogmeta,
         );
 

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

@@ -30 +30 @@
  *
  * @param string $url The original URL (points to wp-signup.php by default).
- *
  * @return string The new URL.
  */
@@ -54 +53 @@
  *
  * @param array $retval Current SQL clauses in array format.
- *
  * @return array
  */
@@ -70 +68 @@
  * @since 2.2.0
  *
- * @param  bool $return  Whether the post should be published.
- * @param  int  $blog_id ID of the blog.
- * @param  int  $post_id ID of the post.
- * @param  int  $user_id ID of the post author.
- *
+ * @param bool $return  Whether the post should be published.
+ * @param int  $blog_id ID of the blog.
+ * @param int  $post_id ID of the post.
+ * @param int  $user_id ID of the post author.
  * @return bool True to authorize the post to be published, otherwise false.
  */

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -43 +43 @@
 function bp_blogs_get_blogs( $args = '' ) {
 
-        // Parse query arguments
+        // Parse query arguments.
         $r = bp_parse_args( $args, array(
                 'type'              => 'active', // 'active', 'alphabetical', 'newest', or 'random'
@@ -54 +54 @@
         ), 'blogs_get_blogs' );
 
-        // Get the blogs
+        // Get the blogs.
         $blogs = BP_Blogs_Blog::get(
                 $r['type'],
@@ -65 +65 @@
         );
 
-        // Filter and return
+        // Filter and return.
         return apply_filters( 'bp_blogs_get_blogs', $blogs, $r );
 }
@@ -83 +83 @@
         global $wpdb;
 
-        // Query for all sites in network
+        // Query for all sites in network.
         if ( is_multisite() ) {
 
-                // Get blog ID's if not a large network
+                // Get blog ID's if not a large network.
                 if ( ! wp_is_large_network() ) {
                         $blog_ids = $wpdb->get_col( $wpdb->prepare( "SELECT blog_id FROM {$wpdb->base_prefix}blogs WHERE mature = 0 AND spam = 0 AND deleted = 0 AND site_id = %d", $wpdb->siteid ) );
 
-                        // If error running this query, set blog ID's to false
+                        // If error running this query, set blog ID's to false.
                         if ( is_wp_error( $blog_ids ) ) {
                                 $blog_ids = false;
                         }
 
-                // Large networks are not currently supported
+                // Large networks are not currently supported.
                 } else {
                         $blog_ids = false;
                 }
 
-        // Record a single site
+        // Record a single site.
         } else {
                 $blog_ids = $wpdb->blogid;
         }
 
-        // Bail if there are no blogs in the network
+        // Bail if there are no blogs in the network.
         if ( empty( $blog_ids ) ) {
                 return false;
         }
 
-        // Get BuddyPress
+        // Get BuddyPress.
         $bp = buddypress();
 
-        // Truncate user blogs table
+        // Truncate user blogs table.
         $truncate = $wpdb->query( "TRUNCATE {$bp->blogs->table_name}" );
         if ( is_wp_error( $truncate ) ) {
@@ -119 +119 @@
         }
 
-        // Truncate user blogsmeta table
+        // Truncate user blogsmeta table.
         $truncate = $wpdb->query( "TRUNCATE {$bp->blogs->table_name_blogmeta}" );
         if ( is_wp_error( $truncate ) ) {
@@ -125 +125 @@
         }
 
-        // Loop through users of blogs and record the relationship
+        // Loop through users of blogs and record the relationship.
         foreach ( (array) $blog_ids as $blog_id ) {
 
-                // Ensure that the cache is clear after the table TRUNCATE above
+                // Ensure that the cache is clear after the table TRUNCATE above.
                 wp_cache_delete( $blog_id, 'blog_meta' );
 
-                // Get all users
+                // Get all users.
                 $users = get_users( array(
                         'blog_id' => $blog_id
                 ) );
 
-                // Continue on if no users exist for this site (how did this happen?)
+                // Continue on if no users exist for this site (how did this happen?).
                 if ( empty( $users ) ) {
                         continue;
                 }
 
-                // Loop through users and record their relationship to this blog
+                // Loop through users and record their relationship to this blog.
                 foreach ( (array) $users as $user ) {
                         bp_blogs_add_user_to_blog( $user->ID, false, $blog_id );
@@ -154 +154 @@
         do_action( 'bp_blogs_recorded_existing_blogs' );
 
-        // No errors
+        // No errors.
         return true;
 }
@@ -170 +170 @@
  * @param int $blog_id ID of the blog being checked.
  * @param int $user_id Optional. ID of the user for whom access is being checked.
- *
  * @return bool True if blog is recordable, otherwise false.
  */
@@ -203 +202 @@
  * @param int $blog_id ID of the blog being checked.
  * @param int $user_id Optional. ID of the user for whom access is being checked.
- *
  * @return bool True if blog is trackable, otherwise false.
  */
@@ -234 +232 @@
  * @param bool $no_activity Optional. Whether to skip recording an activity
  *                          item about this blog creation. Default: false.
- *
  * @return bool|null Returns false on failure.
  */
@@ -261 +258 @@
                 $thread_depth = get_blog_option( $blog_id, 'thread_comments_depth' );
         } else {
-                // perhaps filter this?
+                // Perhaps filter this?
                 $thread_depth = 1;
         }
@@ -282 +279 @@
         $is_private = !apply_filters( 'bp_is_new_blog_public', !$is_private );
 
-        // Only record this activity if the blog is public
+        // Only record this activity if the blog is public.
         if ( !$is_private && !$no_activity && bp_blogs_is_blog_trackable( $blog_id, $user_id ) ) {
 
-                // Record this in activity streams
+                // Record this in activity streams.
                 bp_blogs_record_activity( array(
                         'user_id'      => $recorded_blog->user_id,
@@ -565 +562 @@
  * @param bool|string $is_approved Optional. The $is_approved value passed to
  *                                 the 'comment_post' action. Default: true.
- *
  * @return bool|object Returns false on failure, the comment object on success.
  */
 function bp_blogs_record_comment( $comment_id, $is_approved = true ) {
-        // bail if activity component is not active
+        // Bail if activity component is not active.
         if ( ! bp_is_active( 'activity' ) ) {
                 return;
         }
 
-        // Get the users comment
+        // Get the users comment.
         $recorded_comment = get_comment( $comment_id );
 
-        // Don't record activity if the comment hasn't been approved
+        // Don't record activity if the comment hasn't been approved.
         if ( empty( $is_approved ) )
                 return false;
 
-        // Don't record activity if no email address has been included
+        // Don't record activity if no email address has been included.
         if ( empty( $recorded_comment->comment_author_email ) )
                 return false;
 
-        // Don't record activity if the comment has already been marked as spam
+        // Don't record activity if the comment has already been marked as spam.
         if ( 'spam' === $is_approved )
                 return false;
@@ -592 +588 @@
         $user = get_user_by( 'email', $recorded_comment->comment_author_email );
 
-        // If user isn't registered, don't record activity
+        // If user isn't registered, don't record activity.
         if ( empty( $user ) )
                 return false;
 
-        // Get the user_id
+        // Get the user_id.
         $user_id = (int) $user->ID;
 
-        // Get blog and post data
+        // Get blog and post data.
         $blog_id = get_current_blog_id();
 
@@ -611 +607 @@
                 return false;
 
-        // If this is a password protected post, don't record the comment
+        // If this is a password protected post, don't record the comment.
         if ( !empty( $recorded_comment->post->post_password ) )
                 return false;
 
-        // Don't record activity if the comment's associated post isn't a WordPress Post
+        // Don't record activity if the comment's associated post isn't a WordPress Post.
         if ( !in_array( $recorded_comment->post->post_type, apply_filters( 'bp_blogs_record_comment_post_types', array( 'post' ) ) ) )
                 return false;
@@ -621 +617 @@
         $is_blog_public = apply_filters( 'bp_is_blog_public', (int)get_blog_option( $blog_id, 'blog_public' ) );
 
-        // If blog is public allow activity to be posted
+        // If blog is public allow activity to be posted.
         if ( $is_blog_public ) {
 
-                // Get activity related links
+                // Get activity related links.
                 $post_permalink = get_permalink( $recorded_comment->comment_post_ID );
                 $comment_link   = get_comment_link( $recorded_comment->comment_ID );
 
-                // Setup activity args
+                // Setup activity args.
                 $args = array();
 
@@ -637 +633 @@
 
                 // Setup some different activity args depending if activity commenting is
-                // enabled or not
-
+                // enabled or not.
                 // if cannot comment, record separate activity entry
-                // this is the old way of doing things
+                // this is the old way of doing things.
                 if ( bp_disable_blogforum_comments() ) {
                         $args['type']              = 'new_blog_comment';
@@ -646 +641 @@
                         $args['secondary_item_id'] = $comment_id;
 
-                        // record the activity entry
+                        // Record the activity entry.
                         $activity_id = bp_blogs_record_activity( $args );
 
-                        // add some post info in activity meta
+                        // Add some post info in activity meta.
                         bp_activity_update_meta( $activity_id, 'post_title', $recorded_comment->post->post_title );
                         bp_activity_update_meta( $activity_id, 'post_url',   add_query_arg( 'p', $recorded_comment->post->ID, home_url( '/' ) ) );
 
-                // record comment as BP activity comment under the parent 'new_blog_post'
-                // activity item
+                // Record comment as BP activity comment under the parent 'new_blog_post'
+                // activity item.
                 } else {
-                        // this is a comment edit
-                        // check to see if corresponding activity entry already exists
+                        // This is a comment edit
+                        // check to see if corresponding activity entry already exists.
                         if ( ! empty( $_REQUEST['action'] ) ) {
                                 $existing_activity_id = get_comment_meta( $comment_id, 'bp_activity_comment_id', true );
@@ -666 +661 @@
                         }
 
-                        // find the parent 'new_blog_post' activity entry
+                        // Find the parent 'new_blog_post' activity entry.
                         $parent_activity_id = bp_activity_get_activity_id( array(
                                 'component'         => 'blogs',
@@ -674 +669 @@
                         ) );
 
-                        // Try to create a new activity item for the parent blog post
+                        // Try to create a new activity item for the parent blog post.
                         if ( empty( $parent_activity_id ) ) {
                                 $parent_activity_id = bp_activity_post_type_publish( $recorded_comment->comment_post_ID, $recorded_comment->post );
                         }
 
-                        // we found the parent activity entry
-                        // so let's go ahead and reconfigure some activity args
+                        // We found the parent activity entry
+                        // so let's go ahead and reconfigure some activity args.
                         if ( ! empty( $parent_activity_id ) ) {
-                                // set the 'item_id' with the parent activity entry ID
+                                // Set the 'item_id' with the parent activity entry ID.
                                 $args['item_id'] = $parent_activity_id;
 
-                                // now see if the WP parent comment has a BP activity ID
+                                // Now see if the WP parent comment has a BP activity ID.
                                 $comment_parent = 0;
                                 if ( ! empty( $recorded_comment->comment_parent ) ) {
@@ -692 +687 @@
 
                                 // WP parent comment does not have a BP activity ID
-                                // so set to 'new_blog_post' activity ID
+                                // so set to 'new_blog_post' activity ID.
                                 if ( empty( $comment_parent ) ) {
                                         $comment_parent = $parent_activity_id;
@@ -701 +696 @@
                                 $args['type']              = 'activity_comment';
 
-                        // could not find corresponding parent activity entry
-                        // so wipe out $args array
+                        // Could not find corresponding parent activity entry
+                        // so wipe out $args array.
                         } else {
                                 $args = array();
                         }
 
-                        // Record in activity streams
+                        // Record in activity streams.
                         if ( ! empty( $args ) ) {
                                 // @todo should we use bp_activity_new_comment()? that function will also send
-                                // an email to people in the activity comment thread
+                                // an email to people in the activity comment thread.
                                 //
-                                // what if a site already has some comment email notification plugin setup?
+                                // What if a site already has some comment email notification plugin setup?
                                 // this is why I decided to go with bp_activity_add() to avoid any conflict
-                                // with existing comment email notification plugins
+                                // with existing comment email notification plugins.
                                 $comment_activity_id = bp_activity_add( $args );
 
                                 if ( empty( $args['id'] ) ) {
-                                        // add meta to activity comment
+                                        // Add meta to activity comment.
                                         bp_activity_update_meta( $comment_activity_id, 'bp_blogs_post_comment_id', $comment_id );
                                         bp_activity_update_meta( $comment_activity_id, 'post_title', $recorded_comment->post->post_title );
                                         bp_activity_update_meta( $comment_activity_id, 'post_url', add_query_arg( 'p', $recorded_comment->post->ID, home_url( '/' ) ) );
 
-                                        // add meta to comment
+                                        // Add meta to comment.
                                         add_comment_meta( $comment_id, 'bp_activity_comment_id', $comment_activity_id );
                                 }
@@ -729 +724 @@
                 }
 
-                // Update the blogs last active date
+                // Update the blogs last active date.
                 bp_blogs_update_blogmeta( $blog_id, 'last_activity', bp_core_current_time() );
         }
@@ -752 +747 @@
  * @param string|bool $role    User's WordPress role for this blog ID.
  * @param int         $blog_id Blog ID user is being added to.
- *
  * @return bool|null False on failure.
  */
@@ -758 +752 @@
         global $wpdb;
 
-        // If no blog ID was passed, use the root blog ID
+        // If no blog ID was passed, use the root blog ID.
         if ( empty( $blog_id ) ) {
                 $blog_id = isset( $wpdb->blogid ) ? $wpdb->blogid : bp_get_root_blog_id();
         }
 
-        // If no role was passed, try to find the blog role
+        // If no role was passed, try to find the blog role.
         if ( empty( $role ) ) {
 
-                // Get user capabilities
+                // Get user capabilities.
                 $key        = $wpdb->get_blog_prefix( $blog_id ). 'capabilities';
                 $user_roles = array_keys( (array) bp_get_user_meta( $user_id, $key, true ) );
 
-                // User has roles so lets
+                // User has roles so lets.
                 if ( ! empty( $user_roles ) ) {
 
-                        // Get blog roles
+                        // Get blog roles.
                         $blog_roles      = array_keys( bp_get_current_blog_roles() );
 
-                        // Look for blog only roles of the user
+                        // Look for blog only roles of the user.
                         $intersect_roles = array_intersect( $user_roles, $blog_roles );
 
@@ -789 +783 @@
         }
 
-        // Bail if no role was found or role is not in the allowed roles array
+        // Bail if no role was found or role is not in the allowed roles array.
         if ( empty( $role ) || ! in_array( $role, bp_blogs_get_allowed_roles() ) ) {
                 return false;
         }
 
-        // Record the blog activity for this user being added to this blog
+        // Record the blog activity for this user being added to this blog.
         bp_blogs_record_blog( $blog_id, $user_id, true );
 }
@@ -873 +867 @@
         BP_Blogs_Blog::delete_blog_for_all( $blog_id );
 
-        // Delete activity stream item
+        // Delete activity stream item.
         bp_blogs_delete_activity( array(
                 'item_id'   => $blog_id,
@@ -915 +909 @@
         BP_Blogs_Blog::delete_blog_for_user( $blog_id, $user_id );
 
-        // Delete activity stream item
+        // Delete activity stream item.
         bp_blogs_delete_activity( array(
                 'item_id'   => $blog_id,
@@ -941 +935 @@
  * @param int $user_id Optional. Defaults to the logged-in user ID. This param
  *                     is currently unused in the function (but is passed to hooks).
- *
  * @return bool
  */
@@ -969 +962 @@
         do_action( 'bp_blogs_before_remove_post', $blog_id, $post_id, $user_id );
 
-        // Delete activity stream item
+        // Delete activity stream item.
         bp_blogs_delete_activity( array(
                 'item_id'           => $blog_id,
@@ -998 +991 @@
         global $wpdb;
 
-        // activity comments are disabled for blog posts
-        // which means that individual activity items exist for blog comments
+        // Activity comments are disabled for blog posts
+        // which means that individual activity items exist for blog comments.
         if ( bp_disable_blogforum_comments() ) {
-                // Delete the individual activity stream item
+                // Delete the individual activity stream item.
                 bp_blogs_delete_activity( array(
                         'item_id'           => $wpdb->blogid,
@@ -1008 +1001 @@
                 ) );
 
-        // activity comments are enabled for blog posts
-        // remove the associated activity item
+        // Activity comments are enabled for blog posts
+        // remove the associated activity item.
         } else {
-                // get associated activity ID from comment meta
+                // Get associated activity ID from comment meta.
                 $activity_id = get_comment_meta( $comment_id, 'bp_activity_comment_id', true );
 
-                // delete the associated activity comment
+                // Delete the associated activity comment.
                 //
-                // also removes child post comments and associated activity comments
+                // Also removes child post comments and associated activity comments.
                 if ( ! empty( $activity_id ) && bp_is_active( 'activity' ) ) {
-                        // fetch the activity comments for the activity item
+                        // Fetch the activity comments for the activity item.
                         $activity = bp_activity_get( array(
                                 'in'               => $activity_id,
@@ -1025 +1018 @@
                         ) );
 
-                        // get all activity comment IDs for the pending deleted item
+                        // Get all activity comment IDs for the pending deleted item.
                         if ( ! empty( $activity['activities'] ) ) {
                                 $activity_ids   = bp_activity_recurse_comments_activity_ids( $activity );
                                 $activity_ids[] = $activity_id;
 
-                                // delete activity items
+                                // Delete activity items.
                                 foreach ( $activity_ids as $activity_id ) {
                                         bp_activity_delete( array(
@@ -1037 +1030 @@
                                 }
 
-                                // remove associated blog comments
+                                // Remove associated blog comments.
                                 bp_blogs_remove_associated_blog_comments( $activity_ids );
 
-                                // rebuild activity comment tree
+                                // Rebuild activity comment tree.
                                 BP_Activity_Activity::rebuild_activity_comment_tree( $activity['activities'][0]->item_id );
                         }
@@ -1069 +1062 @@
  * @param array $activity_ids The activity IDs to check association with blog
  *                            comments.
- * @param bool $force_delete  Whether to force delete the comments. If false,
+ * @param bool  $force_delete  Whether to force delete the comments. If false,
  *                            comments are trashed instead.
  */
 function bp_blogs_remove_associated_blog_comments( $activity_ids = array(), $force_delete = true ) {
-        // query args
+        // Query args.
         $query_args = array(
                 'meta_query' => array(
@@ -1084 +1077 @@
         );
 
-        // get comment
+        // Get comment.
         $comment_query = new WP_Comment_Query;
         $comments = $comment_query->query( $query_args );
 
-        // found the corresponding comments
+        // Found the corresponding comments
         // let's delete them!
         foreach ( $comments as $comment ) {
                 wp_delete_comment( $comment->comment_ID, $force_delete );
 
-                // if we're trashing the comment, remove the meta key as well
+                // If we're trashing the comment, remove the meta key as well.
                 if ( empty( $force_delete ) ) {
                         delete_comment_meta( $comment->comment_ID, 'bp_activity_comment_id' );
@@ -1111 +1104 @@
 function bp_blogs_transition_activity_status( $new_status, $old_status, $comment ) {
 
-        // Check the Activity component is active
+        // Check the Activity component is active.
         if ( ! bp_is_active( 'activity' ) )
                 return;
@@ -1136 +1129 @@
         }
 
-        // Get the activity
+        // Get the activity.
         if ( bp_disable_blogforum_comments() ) {
                 $activity_id = bp_activity_get_activity_id( array(
@@ -1148 +1141 @@
         }
 
-        // Check activity item exists
+        // Check activity item exists.
         if ( empty( $activity_id ) ) {
                 // If no activity exists, but the comment has been approved, record it into the activity table.
@@ -1158 +1151 @@
         }
 
-        // Create an activity object
+        // Create an activity object.
         $activity = new BP_Activity_Activity( $activity_id );
         if ( empty( $activity->component ) )
                 return;
 
-        // Spam/ham the activity if it's not already in that state
+        // Spam/ham the activity if it's not already in that state.
         if ( 'spam_activity' == $action && ! $activity->is_spam ) {
                 bp_activity_mark_as_spam( $activity );
@@ -1170 +1163 @@
         }
 
-        // Add "new_blog_comment" to the whitelisted activity types, so that the activity's Akismet history is generated
+        // Add "new_blog_comment" to the whitelisted activity types, so that the activity's Akismet history is generated.
         $comment_akismet_history = create_function( '$t', '$t[] = "new_blog_comment"; return $t;' );
         add_filter( 'bp_akismet_get_activity_types', $comment_akismet_history );
 
-        // Save the updated activity
+        // Save the updated activity.
         $activity->save();
 
-        // Remove the "new_blog_comment" activity type whitelist so we don't break anything
+        // Remove the "new_blog_comment" activity type whitelist so we don't break anything.
         remove_filter( 'bp_akismet_get_activity_types', $comment_akismet_history );
 }
@@ -1205 +1198 @@
  * @param int $user_id ID of the user being queried. Default: on a user page,
  *                     the displayed user. Otherwise, the logged-in user.
- *
  * @return int $count Total blog count for the user.
  */
@@ -1213 +1205 @@
         }
 
-        // no user ID? do not attempt to look at cache
+        // No user ID? do not attempt to look at cache.
         if ( empty( $user_id ) ) {
                 return 0;
@@ -1247 +1239 @@
         BP_Blogs_Blog::delete_blog_for_all( $blog_id );
 
-        // Delete activity stream item
+        // Delete activity stream item.
         bp_blogs_delete_activity( array(
                 'item_id'   => $blog_id,
@@ -1274 +1266 @@
  * @param int  $user_id     See {@BP_Blogs_Blog::get_blogs_for_user()}.
  * @param bool $show_hidden See {@BP_Blogs_Blog::get_blogs_for_user()}.
- *
  * @return array See {@BP_Blogs_Blog::get_blogs_for_user()}.
  */
@@ -1288 +1279 @@
  * @param int $limit See {@BP_Blogs_Blog::get_all()}.
  * @param int $page  See {@BP_Blogs_Blog::get_all()}.
- *
  * @return array See {@BP_Blogs_Blog::get_all()}.
  */
@@ -1302 +1292 @@
  * @param int $limit See {@BP_Blogs_Blog::get()}.
  * @param int $page  See {@BP_Blogs_Blog::get()}.
- *
  * @return array See {@BP_Blogs_Blog::get()}.
  */
@@ -1315 +1304 @@
  *
  * @param int $blog_id See {@BP_Blogs_Blog::is_hidden()}.
- *
  * @return bool See {@BP_Blogs_Blog::is_hidden()}.
  */
@@ -1322 +1310 @@
 }
 
-/*******************************************************************************
+/*
  * Blog meta functions
  *
@@ -1343 +1331 @@
  *                                deleted if the meta_value matches this parameter.
  * @param bool        $delete_all Optional. If true, delete matching metadata entries for
- *                                   all objects, ignoring the specified blog_id. Otherwise, only
- *                                   delete matching metadata entries for the specified blog.
- *                                   Default: false.
- *
+ *                                all objects, ignoring the specified blog_id. Otherwise, only
+ *                                delete matching metadata entries for the specified blog.
+ *                                Default: false.
  * @return bool True on success, false on failure.
  */
@@ -1352 +1339 @@
         global $wpdb;
 
-        // Legacy - if no meta_key is passed, delete all for the blog_id
+        // Legacy - if no meta_key is passed, delete all for the blog_id.
         if ( empty( $meta_key ) ) {
                 $keys = $wpdb->get_col( $wpdb->prepare( "SELECT meta_key FROM {$wpdb->blogmeta} WHERE blog_id = %d", $blog_id ) );
@@ -1384 +1371 @@
  *                         metadata for the blog 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.
  */
@@ -1408 +1394 @@
  *                           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,
@@ -1432 +1417 @@
  *                           for the 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.
  */
@@ -1446 +1430 @@
  *
  * @param int $user_id ID whose blog data should be removed.
- *
- * @return bool|null Returns false on failure.
+ * @return bool Returns false on failure.
  */
 function bp_blogs_remove_data( $user_id ) {
@@ -1490 +1473 @@
         }
 
-        // Get the user's blogs
+        // Get the user's blogs.
         $user_blogs = get_blogs_of_user( $user_id );
         if ( empty( $user_blogs ) ) {

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

@@ -11 +11 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Creates our Blogs component.
+ */
 class BP_Blogs_Component extends BP_Component {
 
@@ -52 +55 @@
                 }
 
-                // Global tables for messaging component
+                // Global tables for messaging component.
                 $global_tables = array(
                         'table_name'          => $bp->table_prefix . 'bp_user_blogs',
@@ -66 +69 @@
                         'slug'                  => BP_BLOGS_SLUG,
                         'root_slug'             => isset( $bp->pages->blogs->slug ) ? $bp->pages->blogs->slug : BP_BLOGS_SLUG,
-                        'has_directory'         => is_multisite(), // Non-multisite installs don't need a top-level Sites directory, since there's only one site
+                        'has_directory'         => is_multisite(), // Non-multisite installs don't need a top-level Sites directory, since there's only one site.
                         'directory_title'       => _x( 'Sites', 'component directory title', 'buddypress' ),
                         'notification_callback' => 'bp_blogs_format_notifications',
@@ -75 +78 @@
                 );
 
-                // Setup the globals
+                // Setup the globals.
                 parent::setup_globals( $args );
 
-                /*
+                /**
                  * Filters if a blog is public.
                  *
@@ -85 +88 @@
                  * @since 2.3.0
                  *
-                 * @oaram int $value Whether or not the blog is public.
+                 * @param int $value Whether or not the blog is public.
                  */
                 if ( 0 !== apply_filters( 'bp_is_blog_public', (int) get_option( 'blog_public' ) ) || ! is_multisite() ) {
@@ -117 +120 @@
         public function includes( $includes = array() ) {
 
-                // Files to include
+                // Files to include.
                 $includes = array(
                         'cache',
@@ -133 +136 @@
                 }
 
-                // Include the files
+                // Include the files.
                 parent::includes( $includes );
         }
@@ -158 +161 @@
                 }
 
-                // Determine user to use
+                // Determine user to use.
                 if ( bp_displayed_user_domain() ) {
                         $user_domain = bp_displayed_user_domain();
@@ -170 +173 @@
                 $parent_url = trailingslashit( $user_domain . $slug );
 
-                // Add 'Sites' to the main navigation
+                // Add 'Sites' to the main navigation.
                 $count    = (int) bp_get_total_blog_count_for_user();
                 $class    = ( 0 === $count ) ? 'no-count' : 'count';
@@ -192 +195 @@
                 );
 
-                // Setup navigation
+                // Setup navigation.
                 parent::setup_nav( $main_nav, $sub_nav );
         }
@@ -205 +208 @@
          * @param array $wp_admin_nav See BP_Component::setup_admin_bar()
          *                            for description.
-         *
          * @return bool
          */
@@ -219 +221 @@
                 }
 
-                // 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.
                         $blogs_link = trailingslashit( bp_loggedin_user_domain() . bp_get_blogs_slug() );
 
-                        // Add the "Sites" sub menu
+                        // Add the "Sites" sub menu.
                         $wp_admin_nav[] = array(
                                 'parent' => buddypress()->my_account_menu_id,
@@ -233 +235 @@
                         );
 
-                        // My Sites
+                        // My Sites.
                         $wp_admin_nav[] = array(
                                 'parent' => 'my-account-' . $this->id,
@@ -241 +243 @@
                         );
 
-                        // Create a Site
+                        // Create a Site.
                         if ( bp_blog_signup_enabled() ) {
                                 $wp_admin_nav[] = array(
@@ -256 +258 @@
 
         /**
-         * Set up the title for pages and <title>
+         * Set up the title for pages and <title>.
          */
         public function setup_title() {
 
-                // Set up the component options navigation for Site
+                // Set up the component options navigation for Site.
                 if ( bp_is_blogs_component() ) {
                         $bp = buddypress();
@@ -270 +272 @@
 
                         // If we are not viewing the logged in user, set up the current
-                        // users avatar and name
+                        // users avatar and name.
                         } else {
                                 $bp->bp_options_avatar = bp_core_fetch_avatar( array(
@@ -291 +293 @@
         public function setup_cache_groups() {
 
-                // Global groups
+                // Global groups.
                 wp_cache_add_global_groups( array(
                         'blog_meta'
@@ -306 +308 @@
          * @see bp_activity_get_post_type_tracking_args() for information on parameters.
          *
-         * @param object|null $params
-         * @param string|int  $post_type
-         *
+         * @param object|null $params    Tracking arguments.
+         * @param string|int  $post_type Post type to track.
          * @return object
          */

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -96 +96 @@
         public function is_blogs() {
 
-                // Bail if not looking at a group
+                // Bail if not looking at a group.
                 if ( ! bp_is_blogs_component() )
                         return;
 
-                // Bail if looking at a users sites
+                // Bail if looking at a users sites.
                 if ( bp_is_user() )
                         return;
 
-                // Blog Directory
+                // Blog Directory.
                 if ( is_multisite() && ! bp_current_action() ) {
                         bp_update_is_directory( true, 'blogs' );
@@ -120 +120 @@
                         add_filter( 'bp_replace_the_content',                    array( $this, 'directory_content'    ) );
 
-                // Create blog
+                // Create blog.
                 } elseif ( is_user_logged_in() && bp_blog_signup_enabled() ) {
                         add_filter( 'bp_get_buddypress_template',                array( $this, 'create_template_hierarchy' ) );
@@ -139 +139 @@
          *
          * @param string $templates The templates from bp_get_theme_compat_templates().
-         *
          * @return array $templates Array of custom templates to look for.
          */
@@ -156 +155 @@
 
                 // 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 );
 
@@ -202 +201 @@
          *
          * @param string $templates The templates from bp_get_theme_compat_templates().
-         *
          * @return array $templates Array of custom templates to look for.
          */
@@ -219 +217 @@
 
                 // 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 );
 
@@ -232 +230 @@
         public function create_dummy_post() {
 
-                // Title based on ability to create blogs
+                // Title based on ability to create blogs.
                 if ( is_user_logged_in() && bp_blog_signup_enabled() ) {
                         $title = __( 'Create a Site', 'buddypress' );

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

@@ -195 +195 @@
                 $this->pag_num  = bp_sanitize_pagination_arg( 'num',          $per_page );
 
-                // Backwards compatibility support for blogs by first letter
+                // Backwards compatibility support for blogs by first letter.
                 if ( ! empty( $_REQUEST['letter'] ) ) {
                         $this->blogs = BP_Blogs_Blog::get_by_letter( $_REQUEST['letter'], $this->pag_num, $this->pag_page );
 
-                // Typical blogs query
+                // Typical blogs query.
                 } else {
                         $this->blogs = bp_blogs_get_blogs( array(
@@ -212 +212 @@
                 }
 
-                // Set the total blog count
+                // Set the total blog count.
                 if ( empty( $max ) || ( $max >= (int) $this->blogs['total'] ) ) {
                         $this->total_blog_count = (int) $this->blogs['total'];
@@ -219 +219 @@
                 }
 
-                // Set the blogs array (to loop through later
+                // Set the blogs array (to loop through later.
                 $this->blogs = $this->blogs['blogs'];
 
-                // Get the current blog count to compare maximum against
+                // Get the current blog count to compare maximum against.
                 $blog_count = count( $this->blogs );
 
-                // Set the current blog count
+                // Set the current blog count.
                 if ( empty( $max ) || ( $max >= (int) $blog_count ) ) {
                         $this->blog_count = (int) $blog_count;
@@ -232 +232 @@
                 }
 
-                // Build pagination links based on total blogs and current page number
+                // Build pagination links based on total blogs and current page number.
                 if ( ! empty( $this->total_blog_count ) && ! empty( $this->pag_num ) ) {
                         $this->pag_links = paginate_links( array(
@@ -302 +302 @@
                          */
                         do_action( 'blog_loop_end' );
-                        // Do some cleaning up after the loop
+                        // Do some cleaning up after the loop.
                         $this->rewind_blogs();
                 }
@@ -324 +324 @@
                 $this->blog        = $this->next_blog();
 
-                // loop has just started
+                // Loop has just started.
                 if ( 0 === $this->current_blog ) {
 
@@ -396 +396 @@
         }
 
-        // Parse arguments
+        // Parse arguments.
         $r = bp_parse_args( $args, array(
                 'type'              => 'active',
-                'page_arg'          => 'bpage',                // See https://buddypress.trac.wordpress.org/ticket/3679
+                'page_arg'          => 'bpage', // See https://buddypress.trac.wordpress.org/ticket/3679.
                 'page'              => 1,
                 'per_page'          => 20,
                 'max'               => false,
-                'user_id'           => bp_displayed_user_id(), // Pass a user_id to limit to only blogs this user is a member of
+                'user_id'           => bp_displayed_user_id(), // Pass a user_id to limit to only blogs this user is a member of.
                 'include_blog_ids'  => false,
                 'search_terms'      => $search_terms_default,
@@ -409 +409 @@
         ), 'has_blogs' );
 
-        // Set per_page to maximum if max is enforced
+        // Set per_page to maximum if max is enforced.
         if ( ! empty( $r['max'] ) && ( (int) $r['per_page'] > (int) $r['max'] ) ) {
                 $r['per_page'] = (int) $r['max'];
         }
 
-        // Get the blogs
+        // Get the blogs.
         $blogs_template = new BP_Blogs_Template( $r['type'], $r['page'], $r['per_page'], $r['max'], $r['user_id'], $r['search_terms'], $r['page_arg'], $r['update_meta_cache'], $r['include_blog_ids'] );
 
@@ -550 +550 @@
                 $author_displayname = bp_core_get_user_displayname( $blogs_template->blog->admin_user_id );
 
-                // Parse the arguments
+                // Parse the arguments.
                 $r = bp_parse_args( $args, array(
                         'type'    => 'full',
@@ -562 +562 @@
                 ) );
 
-                // Fetch the avatar
+                // Fetch the avatar.
                 $avatar = bp_core_fetch_avatar( array(
                         'item_id'    => $blogs_template->blog->admin_user_id,
                         'title'      => $r['title'],
-                        //'avatar_dir' => 'blog-avatars',
-                        //'object'     => 'blog',
+                        // 'avatar_dir' => 'blog-avatars',
+                        // 'object'     => 'blog',
                         'type'       => $r['type'],
                         'alt'        => $r['alt'],
@@ -576 +576 @@
                 ) );
 
-                /***
+                /**
                  * In future BuddyPress versions you will be able to set the avatar for a blog.
                  * Right now you can use a filter with the ID of the blog to change it if you wish.
@@ -714 +714 @@
  * @since 1.7.0
  *
- * @param array $classes Array of custom classes
+ * @param array $classes Array of custom classes.
  */
 function bp_blog_class( $classes = array() ) {
@@ -725 +725 @@
          *
          * @global BP_Blogs_Template $blogs_template
-         * @param array $classes Array of custom classes
-         *
+         *
+         * @param array $classes Array of custom classes.
          * @return string Row class of the site.
          */
@@ -732 +732 @@
                 global $blogs_template;
 
-                // Add even/odd classes, but only if there's more than 1 group
+                // Add even/odd classes, but only if there's more than 1 group.
                 if ( $blogs_template->blog_count > 1 ) {
                         $pos_in_loop = (int) $blogs_template->current_blog;
                         $classes[]   = ( $pos_in_loop % 2 ) ? 'even' : 'odd';
 
-                // If we've only one site in the loop, don't bother with odd and even
+                // If we've only one site in the loop, don't bother with odd and even.
                 } else {
                         $classes[] = 'bp-single-blog';
@@ -778 +778 @@
                 global $blogs_template;
 
-                // Parse the activity format
+                // Parse the activity format.
                 $r = bp_parse_args( $args, array(
                         'active_format' => true
                 ) );
 
-                // Backwards compatibility for anyone forcing a 'true' active_format
+                // Backwards compatibility for anyone forcing a 'true' active_format.
                 if ( true === $r['active_format'] ) {
                         $r['active_format'] = __( 'active %s', 'buddypress' );
                 }
 
-                // Blog has been posted to at least once
+                // Blog has been posted to at least once.
                 if ( isset( $blogs_template->blog->last_activity ) ) {
 
-                        // Backwards compatibility for pre 1.5 'ago' strings
+                        // Backwards compatibility for pre 1.5 'ago' strings.
                         $last_activity = ! empty( $r['active_format'] )
                                 ? bp_core_get_last_activity( $blogs_template->blog->last_activity, $r['active_format'] )
                                 : bp_core_time_since( $blogs_template->blog->last_activity );
 
-                // Blog has never been posted to
+                // Blog has never been posted to.
                 } else {
                         $last_activity = __( 'Never active', 'buddypress' );
@@ -1000 +1000 @@
          * @param string $size Image version to return. 'thumbnail', 'medium',
          *                     'large', or 'post-thumbnail'. Default: 'thumbnail'.
-         *
          * @return string URL of the image.
          */
@@ -1028 +1027 @@
  * @param string $thumbnail Image version to return. 'thumbnail', 'medium', 'large',
  *                          or 'post-thumbnail'. Default: 'thumbnail'.
- *
  * @return bool True if the latest blog post from the current blog has a
  *              featured image of the given size.
@@ -1101 +1099 @@
          *
          * @param int $user_id ID of the user.
-         *
          * @return int Total number of blogs for the user.
          */
@@ -1138 +1135 @@
          * Filters whether or not blog creation is enabled.
          *
+         * Return "all", "none", "blog" or "user".
+         *
          * @since 1.0.0
          *
          * @param string $active_signup Value of the registration site option creation status.
          */
-        $active_signup = apply_filters( 'wpmu_active_signup', $active_signup ); // return "all", "none", "blog" or "user"
+        $active_signup = apply_filters( 'wpmu_active_signup', $active_signup );
 
         if ( 'none' == $active_signup || 'user' == $active_signup )
@@ -1226 +1225 @@
         global $current_site;
 
-        // Blog name
+        // Blog name.
         if( !is_subdomain_install() )
                 echo '<label for="blogname">' . __('Site Name:', 'buddypress') . '</label>';
@@ -1255 +1254 @@
         }
 
-        // Blog Title
+        // Blog Title.
         ?>
 
@@ -1323 +1322 @@
         $public = (int) $_POST['blog_public'];
 
-        $meta = apply_filters( 'signup_create_blog_meta', array( 'lang_id' => 1, 'public' => $public ) ); // depreciated
+        // Depreciated.
+        $meta = apply_filters( 'signup_create_blog_meta', array( 'lang_id' => 1, 'public' => $public ) );
 
         /**
@@ -1398 +1398 @@
 function bp_create_blog_link() {
 
-        // Don't show this link when not on your own profile
+        // Don't show this link when not on your own profile.
         if ( ! bp_is_my_profile() ) {
                 return;
@@ -1420 +1420 @@
 function bp_blogs_blog_tabs() {
 
-        // Don't show these tabs on a user's own profile
+        // Don't show these tabs on a user's own profile.
         if ( bp_is_my_profile() ) {
                 return false;
@@ -1531 +1531 @@
          */
         function bp_get_blog_create_nav_item() {
-                // Get the create a site button
+                // Get the create a site button.
                 $create_blog_button = bp_get_blog_create_button();
 
-                // Make sure the button is available
+                // Make sure the button is available.
                 if ( empty( $create_blog_button ) ) {
                         return;
@@ -1555 +1555 @@
  */
 function bp_blog_backcompat_create_nav_item() {
-        // Bail if Blogs nav item is already used by bp-legacy
+        // Bail if Blogs nav item is already used by bp-legacy.
         if ( has_action( 'bp_blogs_directory_blog_types', 'bp_legacy_theme_blog_create_nav', 999 ) ) {
                 return;
         }
 
-        // Bail if the theme is not filtering the Blogs directory title
+        // Bail if the theme is not filtering the Blogs directory title.
         if ( ! has_filter( 'bp_blogs_directory_header' ) ) {
                 return;
@@ -1634 +1634 @@
  * @uses bp_blogs_admin_get_profile_stats() to get the stats.
  *
- * @param array|string $args before|after|user_id
+ * @param array|string $args Before|after|user_id.
  */
 function bp_blogs_profile_stats( $args = '' ) {
@@ -1646 +1646 @@
  * @since 2.0.0
  *
- * @param array|string $args before|after|user_id
- *
+ * @param array|string $args Before|after|user_id.
  * @return string HTML for stats output.
  */
 function bp_blogs_get_profile_stats( $args = '' ) {
 
-        // Parse the args
+        // Parse the args.
         $r = bp_parse_args( $args, array(
                 'before'  => '<li class="bp-blogs-profile-stats">',
@@ -1661 +1660 @@
         ), 'blogs_get_profile_stats' );
 
-        // Allow completely overloaded output
+        // Allow completely overloaded output.
         if ( is_multisite() && empty( $r['output'] ) ) {
 
-                // Only proceed if a user ID was passed
+                // Only proceed if a user ID was passed.
                 if ( ! empty( $r['user_id'] ) ) {
 
-                        // Get the user's blogs
+                        // Get the user's blogs.
                         if ( empty( $r['blogs'] ) ) {
                                 $r['blogs'] = absint( bp_blogs_total_blogs_for_user( $r['user_id'] ) );
                         }
 
-                        // If blogs exist, show some formatted output
+                        // If blogs exist, show some formatted output.
                         $r['output'] = $r['before'] . sprintf( _n( '%s site', '%s sites', $r['blogs'], 'buddypress' ), '<strong>' . $r['blogs'] . '</strong>' ) . $r['after'];
                 }

trunk/src/bp-blogs/bp-blogs-widgets.php

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -77 +77 @@
                 $after_widget = $args['after_widget'];
 
-                // Override some of the contextually set parameters for bp_has_activities()
+                // Override some of the contextually set parameters for bp_has_activities().
                 $args = array(
                         'action'     => 'new_blog_post',
@@ -128 +128 @@
          * @param array $new_instance The new instance options.
          * @param array $old_instance The old instance options.
-         *
          * @return array $instance The parsed options to be saved.
          */
@@ -145 +144 @@
          * @param array $instance Settings for this widget.
          *
-         * @return string
+         * @return void
          */
         public function form( $instance ) {

trunk/src/bp-blogs/classes/class-bp-blogs-blog.php

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -19 +19 @@
  */
 class BP_Blogs_Blog {
+
+        /**
+         * Site ID.
+         *
+         * @var int|null
+         */
         public $id;
+
+        /**
+         * User ID.
+         *
+         * @var int
+         */
         public $user_id;
+
+        /**
+         * Blog ID.
+         *
+         * @var int
+         */
         public $blog_id;
 
@@ -82 +100 @@
 
                 if ( $this->id ) {
-                        // Update
+                        // Update.
                         $sql = $wpdb->prepare( "UPDATE {$bp->blogs->table_name} SET user_id = %d, blog_id = %d WHERE id = %d", $this->user_id, $this->blog_id, $this->id );
                 } else {
-                        // Save
+                        // Save.
                         $sql = $wpdb->prepare( "INSERT INTO {$bp->blogs->table_name} ( user_id, blog_id ) VALUES ( %d, %d )", $this->user_id, $this->blog_id );
                 }
@@ -141 +159 @@
          *                                       blogs. Default: true.
          * @param array|bool  $include_blog_ids  Array of blog IDs to include.
-         *
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects
@@ -255 +272 @@
          * @param int $user_id Optional. The ID of the user from whom the blog is
          *                     being removed. If absent, defaults to the logged-in user ID.
-         *
          * @return int|bool Number of rows deleted on success, false on failure.
          */
@@ -274 +290 @@
          * @param int $user_id Optional. The ID of the user whose blog associations
          *                     are being deleted. If absent, defaults to logged-in user ID.
-         *
          * @return int|bool Number of rows deleted on success, false on failure.
          */
@@ -300 +315 @@
          * @param bool $show_hidden Optional. Whether to include blogs that are not marked
          *                          public. Defaults to true when viewing one's own profile.
-         *
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects.
@@ -340 +354 @@
          * @param int $user_id Optional. ID of the user whose blogs are being
          *                     queried. Defaults to logged-in user.
-         *
          * @return int The number of blogs associated with the user.
          */
@@ -358 +371 @@
          *
          * @param int $blog_id ID of the blog being queried.
-         *
          * @return int|null The ID of the first located entry in the BP table
          *                  on success, otherwise null.
@@ -379 +391 @@
          * @param int $user_id Optional. ID of the user whose blogs are being
          *                     queried. Defaults to logged-in user.
-         *
          * @return int Blog count for the user.
          */
@@ -409 +420 @@
          * @param int    $page   Optional. The page of results to return. Default:
          *                       null (no limit).
-         *
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects.
@@ -447 +457 @@
          * @param int $page  Optional. The page of results to return. Default:
          *                   null (no limit).
-         *
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects.
@@ -472 +481 @@
          * 'bp_moderate' cap.
          *
-         * @param string $letter. The letter you're looking for.
-         * @param int    $limit   Optional. The maximum number of items to return.
-         *                        Default: null (no limit).
-         * @param int    $page    Optional. The page of results to return. Default:
-         *                        null (no limit).
-         *
+         * @param string $letter The letter you're looking for.
+         * @param int    $limit  Optional. The maximum number of items to return.
+         *                       Default: null (no limit).
+         * @param int    $page   Optional. The page of results to return. Default:
+         *                       null (no limit).
          * @return array Multidimensional results array, structured as follows:
          *               'blogs' - Array of located blog objects.
@@ -516 +524 @@
          * @param array       $blog_ids    Array of IDs returned from the original query.
          * @param string|bool $type        Not currently used. Default: false.
-         *
          * @return array $paged_blogs The located blogs array, with the extras added.
          */
@@ -534 +541 @@
                         $images = array();
 
-                        // Add URLs to any Featured Image this post might have
+                        // Add URLs to any Featured Image this post might have.
                         if ( ! empty( $paged_blogs[$i]->latest_post ) && has_post_thumbnail( $paged_blogs[$i]->latest_post->ID ) ) {
 
@@ -542 +549 @@
                                         $images['thumbnail'] = $image[0];
 
-                                // Medium
+                                // Medium.
                                 $image = wp_get_attachment_image_src( get_post_thumbnail_id( $paged_blogs[$i]->latest_post->ID ), 'medium', false );
                                 if ( ! empty( $image ) )
                                         $images['medium'] = $image[0];
 
-                                // Large
+                                // Large.
                                 $image = wp_get_attachment_image_src( get_post_thumbnail_id( $paged_blogs[$i]->latest_post->ID ), 'large', false );
                                 if ( ! empty( $image ) )
                                         $images['large'] = $image[0];
 
-                                // Post thumbnail
+                                // Post thumbnail.
                                 $image = wp_get_attachment_image_src( get_post_thumbnail_id( $paged_blogs[$i]->latest_post->ID ), 'post-thumbnail', false );
                                 if ( ! empty( $image ) )
                                         $images['post-thumbnail'] = $image[0];
 
-                                // Add the images to the latest_post object
+                                // Add the images to the latest_post object.
                                 $paged_blogs[$i]->latest_post->images = $images;
                         }
@@ -581 +588 @@
          *
          * @param int $blog_id The ID of the blog being checked.
-         *
          * @return bool True if hidden (public = 0), false otherwise.
          */
@@ -599 +605 @@
          * @param int $user_id ID of user.
          * @param int $blog_id ID of blog.
-         *
          * @return int|bool ID of user-blog link, or false if not found.
          */