Changeset 10183 for trunk/src/bp-forums/bp-forums-loader.php

Timestamp:

10/04/2015 07:29:24 AM (11 years ago)

Author:

tw2113

Message:

Initial documentation cleanup for the BP Forums Component.

See #6397.

File:

• trunk/src/bp-forums/bp-forums-loader.php (modified) (13 diffs)

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

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Forums Loader
+ * BuddyPress Forums Loader.
  *
  * A discussion forums component. Comes bundled with bbPress stand-alone.
@@ -48 +48 @@
                 $bp = buddypress();
 
-                // Define the parent forum ID
+                // Define the parent forum ID.
                 if ( ! defined( 'BP_FORUMS_PARENT_FORUM_ID' ) ) {
                         define( 'BP_FORUMS_PARENT_FORUM_ID', 1 );
                 }
 
-                // Define a slug, if necessary
+                // Define a slug, if necessary.
                 if ( ! defined( 'BP_FORUMS_SLUG' ) ) {
                         define( 'BP_FORUMS_SLUG', $this->id );
                 }
 
-                // The location of the bbPress stand-alone config file
+                // The location of the bbPress stand-alone config file.
                 $bbconfig = bp_core_get_root_option( 'bb-config-location' );
                 if ( '' !== $bbconfig ) {
@@ -86 +86 @@
         public function includes( $includes = array() ) {
 
-                // Files to include
+                // Files to include.
                 $includes = array(
                         'actions',
@@ -96 +96 @@
                 );
 
-                // bbPress stand-alone
+                // bbPress stand-alone.
                 if ( ! defined( 'BB_PATH' ) ) {
                         $includes[] = 'bbpress-sa';
                 }
 
-                // Admin-specific code
+                // Admin-specific code.
                 if ( is_admin() ) {
                         $includes[] = 'deprecated/1.6';
@@ -118 +118 @@
          *
          * @param array $main_nav Optional. See BP_Component::setup_nav() for
-         *        description.
-         * @param array $sub_nav Optional. See BP_Component::setup_nav() for
-         *        description.
+         *                        description.
+         * @param array $sub_nav  Optional. See BP_Component::setup_nav() for
+         *                        description.
          */
         public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
-                // Stop if forums haven't been set up yet
+                // Stop if forums haven't been set up yet.
                 if ( ! bp_forums_is_installed_correctly() ) {
                         return;
                 }
 
-                // 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();
@@ -143 +143 @@
                 }
 
-                // User link
+                // User link.
                 $slug        = bp_get_forums_slug();
                 $forums_link = trailingslashit( $user_domain . $slug );
 
-                // Add 'Forums' to the main navigation
+                // Add 'Forums' to the main navigation.
                 $main_nav = array(
                         'name'                => __( 'Forums', 'buddypress' ),
@@ -157 +157 @@
                 );
 
-                // Topics started
+                // Topics started.
                 $sub_nav[] = array(
                         'name'            => __( 'Topics Started', 'buddypress' ),
@@ -168 +168 @@
                 );
 
-                // Topics replied to
+                // Topics replied to.
                 $sub_nav[] = array(
                         'name'            => __( 'Replied To', 'buddypress' ),
@@ -190 +190 @@
          *
          * @param array $wp_admin_nav See BP_Component::setup_admin_bar()
-         *        for description.
+         *                            for description.
          */
         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.
                         $forums_link = trailingslashit( bp_loggedin_user_domain() . bp_get_forums_slug() );
 
-                        // Add the "My Account" sub menus
+                        // Add the "My Account" sub menus.
                         $wp_admin_nav[] = array(
                                 'parent' => buddypress()->my_account_menu_id,
@@ -208 +208 @@
                         );
 
-                        // Topics
+                        // Topics.
                         $wp_admin_nav[] = array(
                                 'parent' => 'my-account-' . $this->id,
@@ -216 +216 @@
                         );
 
-                        // Replies
+                        // Replies.
                         $wp_admin_nav[] = array(
                                 'parent' => 'my-account-' . $this->id,
@@ -224 +224 @@
                         );
 
-                        // Favorites
+                        // Favorites.
                         $wp_admin_nav[] = array(
                                 'parent' => 'my-account-' . $this->id,
@@ -241 +241 @@
         public function setup_title() {
 
-                // Adjust title based on view
+                // Adjust title based on view.
                 if ( bp_is_forums_component() ) {
                         $bp = buddypress();