Changeset 10373 for trunk/src/bp-groups/bp-groups-loader.php

Timestamp:

11/22/2015 04:58:34 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for BP-Groups component.

See #6401.

File:

• trunk/src/bp-groups/bp-groups-loader.php (modified) (31 diffs)

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

@@ -14 +14 @@
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Creates our Groups component.
+ */
 class BP_Groups_Component extends BP_Component {
 
@@ -37 +40 @@
      * @since 1.6.0
      * @todo Is this used anywhere? Is this a duplicate of $default_extension?
+     * @var string
      */
     var $default_component;
@@ -136 +140 @@
         $bp = buddypress();
 
-        // Define a slug, if necessary
+        // Define a slug, if necessary.
         if ( ! defined( 'BP_GROUPS_SLUG' ) ) {
             define( 'BP_GROUPS_SLUG', $this->id );
         }
 
-        // Global tables for groups component
+        // Global tables for groups component.
         $global_tables = array(
             'table_name'           => $bp->table_prefix . 'bp_groups',
@@ -148 +152 @@
         );
 
-        // Metadata tables for groups component
+        // Metadata tables for groups component.
         $meta_tables = array(
             'group' => $bp->table_prefix . 'bp_groups_groupmeta',
@@ -168 +172 @@
         parent::setup_globals( $args );
 
-        /** Single Group Globals **********************************************/
+        /* Single Group Globals **********************************************/
 
         // Are we viewing a single group?
@@ -215 +219 @@
             }
 
-            // If the user is not an admin, check if they are a moderator
+            // If the user is not an admin, check if they are a moderator.
             if ( ! bp_is_item_admin() ) {
                 bp_update_is_item_mod  ( groups_is_user_mod  ( bp_loggedin_user_id(), $this->current_group->id ), 'groups' );
@@ -245 +249 @@
             }
 
-            // Check once if the current group has a custom front template
+            // Check once if the current group has a custom front template.
             $this->current_group->front_template = bp_groups_get_front_template( $this->current_group );
 
-        // Set current_group to 0 to prevent debug errors
+        // Set current_group to 0 to prevent debug errors.
         } else {
             $this->current_group = 0;
@@ -277 +281 @@
         ) );
 
-        // If the user was attempting to access a group, but no group by that name was found, 404
+        // If the user was attempting to access a group, but no group by that name was found, 404.
         if ( bp_is_groups_component() && empty( $this->current_group ) && bp_current_action() && !in_array( bp_current_action(), $this->forbidden_names ) ) {
             bp_do_404();
@@ -301 +305 @@
         ) );
 
-        // If avatar uploads are not disabled, add avatar option
+        // If avatar uploads are not disabled, add avatar option.
         $disabled_avatar_uploads = (int) bp_disable_group_avatar_uploads();
         if ( ! $disabled_avatar_uploads && $bp->avatar->show_avatars ) {
@@ -317 +321 @@
         }
 
-        // If friends component is active, add invitations
+        // If friends component is active, add invitations.
         if ( bp_is_active( 'friends' ) ) {
             $this->group_creation_steps['group-invites'] = array(
@@ -338 +342 @@
         ) );
 
-        // Auto join group when non group member performs group activity
+        // Auto join group when non group member performs group activity.
         $this->auto_join = defined( 'BP_DISABLE_AUTO_GROUP_JOIN' ) && BP_DISABLE_AUTO_GROUP_JOIN ? false : true;
     }
@@ -368 +372 @@
         $bp = buddypress();
 
-        // If the activity component is not active and the current group has no custom front, members are displayed in the home nav
+        // If the activity component is not active and the current group has no custom front, members are displayed in the home nav.
         if ( 'members' === $this->default_extension && ! bp_is_active( 'activity' ) && ! $this->current_group->front_template ) {
             $this->default_extension = 'home';
@@ -377 +381 @@
         }
 
-        // Prepare for a redirect to the canonical URL
+        // Prepare for a redirect to the canonical URL.
         $bp->canonical_stack['base_url'] = bp_get_group_permalink( $this->current_group );
 
@@ -401 +405 @@
         // When viewing the default extension, the canonical URL should not have
         // that extension's slug, unless more has been tacked onto the URL via
-        // action variables
+        // action variables.
         if ( bp_is_current_action( $this->default_extension ) && empty( $bp->action_variables ) )  {
             unset( $bp->canonical_stack['action'] );
@@ -419 +423 @@
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
-        // Determine user to use
+        // Determine user to use.
         if ( bp_displayed_user_domain() ) {
             $user_domain = bp_displayed_user_domain();
@@ -428 +432 @@
         }
 
-        // Only grab count if we're on a user page
+        // Only grab count if we're on a user page.
         if ( bp_is_user() ) {
             $count    = bp_get_total_group_count_for_user();
@@ -439 +443 @@
         $slug = bp_get_groups_slug();
 
-        // Add 'Groups' to the main navigation
+        // Add 'Groups' to the main navigation.
         $main_nav = array(
             'name'                => $nav_name,
@@ -453 +457 @@
             $groups_link = trailingslashit( $user_domain . $slug );
 
-            // Add the My Groups nav item
+            // Add the My Groups nav item.
             $sub_nav[] = array(
                 'name'            => __( 'Memberships', 'buddypress' ),
@@ -464 +468 @@
             );
 
-            // Add the Group Invites nav item
+            // Add the Group Invites nav item.
             $sub_nav[] = array(
                 'name'            => __( 'Invitations', 'buddypress' ),
@@ -480 +484 @@
         if ( bp_is_groups_component() && bp_is_single_item() ) {
 
-            // Reset sub nav
+            // Reset sub nav.
             $sub_nav = array();
 
-            // Add 'Groups' to the main navigation
+            // Add 'Groups' to the main navigation.
             $main_nav = array(
                 'name'                => __( 'Memberships', 'buddypress' ),
                 'slug'                => $this->current_group->slug,
-                'position'            => -1, // Do not show in BuddyBar
+                'position'            => -1, // Do not show in BuddyBar.
                 'screen_function'     => 'groups_screen_group_home',
                 'default_subnav_slug' => $this->default_extension,
@@ -495 +499 @@
             $group_link = bp_get_group_permalink( $this->current_group );
 
-            // Add the "Home" subnav item, as this will always be present
+            // Add the "Home" subnav item, as this will always be present.
             $sub_nav[] = array(
                 'name'            =>  _x( 'Home', 'Group screen navigation title', 'buddypress' ),
@@ -526 +530 @@
             }
 
-            // Forums are enabled and turned on
+            // Forums are enabled and turned on.
             if ( $this->current_group->enable_forum && bp_is_active( 'forums' ) ) {
                 $sub_nav[] = array(
@@ -559 +563 @@
 
                 /**
-                 * Only add the members subnav if it's not the home's nav
+                 * Only add the members subnav if it's not the home's nav.
                  */
                 $sub_nav[] = array(
@@ -588 +592 @@
             }
 
-            // If the user is a group admin, then show the group admin nav item
+            // If the user is a group admin, then show the group admin nav item.
             if ( bp_is_item_admin() ) {
                 $sub_nav[] = array(
@@ -604 +608 @@
                 $admin_link = trailingslashit( $group_link . 'admin' );
 
-                // Common params to all nav items
+                // Common params to all nav items.
                 $default_params = array(
                     'parent_url'        => $admin_link,
@@ -692 +696 @@
     public function setup_admin_bar( $wp_admin_nav = array() ) {
 
-        // Menus for logged in user
+        // Menus for logged in user.
         if ( is_user_logged_in() ) {
 
-            // Setup the logged in user variables
+            // Setup the logged in user variables.
             $groups_link = trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() );
 
-            // Pending group invites
+            // Pending group invites.
             $count   = groups_get_invite_count_for_user();
             $title   = _x( 'Groups', 'My Account Groups', 'buddypress' );
@@ -708 +712 @@
             }
 
-            // Add the "My Account" sub menus
+            // Add the "My Account" sub menus.
             $wp_admin_nav[] = array(
                 'parent' => buddypress()->my_account_menu_id,
@@ -716 +720 @@
             );
 
-            // My Groups
+            // My Groups.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -724 +728 @@
             );
 
-            // Invitations
+            // Invitations.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -732 +736 @@
             );
 
-            // Create a Group
+            // Create a Group.
             if ( bp_user_can_create_groups() ) {
                 $wp_admin_nav[] = array(
@@ -793 +797 @@
     public function setup_cache_groups() {
 
-        // Global groups
+        // Global groups.
         wp_cache_add_global_groups( array(
             'bp_groups',