Changeset 10374 for trunk/src/bp-blogs/bp-blogs-template.php

Timestamp:

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

Author:

tw2113

Message:

More documentation cleanup for BP-Blogs component.

See #6397.

File:

• trunk/src/bp-blogs/bp-blogs-template.php (modified) (29 diffs)

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'];
         }