Changeset 10323 for trunk/src/bp-friends/bp-friends-loader.php

Timestamp:

11/02/2015 02:07:44 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for Friends component.

See #6400.

File:

• trunk/src/bp-friends/bp-friends-loader.php (modified) (11 diffs)

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

@@ -12 +12 @@
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Defines the BuddyPress Friends Component.
+ */
 class BP_Friends_Component extends BP_Component {
 
@@ -75 +78 @@
         }
 
-        // Define a slug, if necessary
+        // Define a slug, if necessary.
         if ( ! defined( 'BP_FRIENDS_SLUG' ) ) {
             define( 'BP_FRIENDS_SLUG', $this->id );
         }
 
-        // Global tables for the friends component
+        // Global tables for the friends component.
         $global_tables = array(
             'table_name'      => $bp->table_prefix . 'bp_friends',
@@ -113 +116 @@
     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();
@@ -126 +129 @@
         $friends_link = trailingslashit( $user_domain . $slug );
 
-        // Add 'Friends' to the main navigation
+        // Add 'Friends' to the main navigation.
         $count    = friends_get_total_friend_count();
         $class    = ( 0 === $count ) ? 'no-count' : 'count';
@@ -138 +141 @@
         );
 
-        // Add the subnav items to the friends nav item
+        // Add the subnav items to the friends nav item.
         $sub_nav[] = array(
             'name'            => _x( 'Friendships', 'Friends screen sub nav', 'buddypress' ),
@@ -174 +177 @@
     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.
             $friends_link = trailingslashit( bp_loggedin_user_domain() . bp_get_friends_slug() );
 
-            // Pending friend requests
+            // Pending friend requests.
             $count = count( friends_get_friendship_request_user_ids( bp_loggedin_user_id() ) );
             if ( !empty( $count ) ) {
@@ -190 +193 @@
             }
 
-            // Add the "My Account" sub menus
+            // Add the "My Account" sub menus.
             $wp_admin_nav[] = array(
                 'parent' => buddypress()->my_account_menu_id,
@@ -198 +201 @@
             );
 
-            // My Friends
+            // My Friends.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -206 +209 @@
             );
 
-            // Requests
+            // Requests.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -223 +226 @@
     public function setup_title() {
 
-        // Adjust title
+        // Adjust title.
         if ( bp_is_friends_component() ) {
             $bp = buddypress();
@@ -249 +252 @@
     public function setup_cache_groups() {
 
-        // Global groups
+        // Global groups.
         wp_cache_add_global_groups( array(
             'bp_friends_requests'