Changeset 10253 for trunk/src/bp-activity/bp-activity-loader.php

Timestamp:

10/12/2015 05:45:14 AM (10 years ago)

Author:

tw2113

Message:

Further documentation cleanup for Activity Component.

See #6396.

File:

• trunk/src/bp-activity/bp-activity-loader.php (modified) (20 diffs)

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

@@ -9 +9 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -47 +47 @@
     public function includes( $includes = array() ) {
 
-        // Files to include
+        // Files to include.
         $includes = array(
             'cssjs',
@@ -60 +60 @@
         );
 
-        // Load Akismet support if Akismet is configured
+        // Load Akismet support if Akismet is configured.
         $akismet_key = bp_get_option( 'wordpress_api_key' );
 
@@ -90 +90 @@
         $bp = buddypress();
 
-        // Define a slug, if necessary
+        // Define a slug, if necessary.
         if ( ! defined( 'BP_ACTIVITY_SLUG' ) ) {
             define( 'BP_ACTIVITY_SLUG', $this->id );
         }
 
-        // Global tables for activity component
+        // Global tables for activity component.
         $global_tables = array(
             'table_name'      => $bp->table_prefix . 'bp_activity',
@@ -101 +101 @@
         );
 
-        // Metadata tables for groups component
+        // Metadata tables for groups component.
         $meta_tables = array(
             'activity' => $bp->table_prefix . 'bp_activity_meta',
@@ -138 +138 @@
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
-        // Stop if there is no user displayed or logged in
+        // Stop if there is no user displayed or logged in.
         if ( ! is_user_logged_in() && ! bp_displayed_user_id() ) {
             return;
         }
 
-        // Determine user to use
+        // Determine user to use.
         if ( bp_displayed_user_domain() ) {
             $user_domain = bp_displayed_user_domain();
@@ -155 +155 @@
         $activity_link = trailingslashit( $user_domain . $slug );
 
-        // Add 'Activity' to the main navigation
+        // Add 'Activity' to the main navigation.
         $main_nav = array(
             'name'                => _x( 'Activity', 'Profile activity screen nav', 'buddypress' ),
@@ -165 +165 @@
         );
 
-        // Add the subnav items to the activity nav item if we are using a theme that supports this
+        // Add the subnav items to the activity nav item if we are using a theme that supports this.
         $sub_nav[] = array(
             'name'            => _x( 'Personal', 'Profile activity screen sub nav', 'buddypress' ),
@@ -175 +175 @@
         );
 
-        // @ mentions
+        // Check @mentions.
         if ( bp_activity_do_mentions() ) {
             $sub_nav[] = array(
@@ -188 +188 @@
         }
 
-        // Favorite activity items
+        // Favorite activity items.
         if ( bp_activity_can_favorite() ) {
             $sub_nav[] = array(
@@ -201 +201 @@
         }
 
-        // Additional menu if friends is active
+        // Additional menu if friends is active.
         if ( bp_is_active( 'friends' ) ) {
             $sub_nav[] = array(
@@ -214 +214 @@
         }
 
-        // Additional menu if groups is active
+        // Additional menu if groups is active.
         if ( bp_is_active( 'groups' ) ) {
             $sub_nav[] = array(
@@ -250 +250 @@
     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.
             $activity_link = trailingslashit( bp_loggedin_user_domain() . bp_get_activity_slug() );
 
-            // Unread message count
+            // Unread message count.
             if ( bp_activity_do_mentions() ) {
                 $count = bp_get_total_mention_count_for_user( bp_loggedin_user_id() );
@@ -266 +266 @@
             }
 
-            // Add the "Activity" sub menu
+            // Add the "Activity" sub menu.
             $wp_admin_nav[] = array(
                 'parent' => buddypress()->my_account_menu_id,
@@ -274 +274 @@
             );
 
-            // Personal
+            // Personal.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -282 +282 @@
             );
 
-            // Mentions
+            // Mentions.
             if ( bp_activity_do_mentions() ) {
                 $wp_admin_nav[] = array(
@@ -292 +292 @@
             }
 
-            // Favorites
-            // Favorite activity items
+            // Favorite activity items.
             if ( bp_activity_can_favorite() ) {
                 $wp_admin_nav[] = array(
@@ -338 +337 @@
     public function setup_title() {
 
-        // Adjust title based on view
+        // Adjust title based on view.
         if ( bp_is_activity_component() ) {
             $bp = buddypress();
@@ -364 +363 @@
     public function setup_actions() {
 
-        // Spam prevention
+        // Spam prevention.
         add_action( 'bp_include', 'bp_activity_setup_akismet' );
 
@@ -377 +376 @@
     public function setup_cache_groups() {
 
-        // Global groups
+        // Global groups.
         wp_cache_add_global_groups( array(
             'bp_activity',