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

Timestamp:

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

Author:

tw2113

Message:

More documentation cleanup for BP-Blogs component.

See #6397.

File:

• trunk/src/bp-blogs/bp-blogs-loader.php (modified) (18 diffs)

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
          */