Changeset 10322 for trunk/src/bp-members/bp-members-loader.php

Timestamp:

11/02/2015 01:58:52 AM (9 years ago)

Author:

tw2113

Message:

More documentation cleanup for the Members component.

See #6402.

File:

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

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

@@ -10 +10 @@
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Defines the BuddyPress Members Component.
+ */
 class BP_Members_Component extends BP_Component {
 
@@ -17 +20 @@
      * @see bp_register_member_type()
      *
-     * @since  2.2.0
-     * @var    array
+     * @since 2.2.0
+     * @var array
      */
     public $types = array();
@@ -48 +51 @@
     public function includes( $includes = array() ) {
 
-        // Always include these files
+        // Always include these files.
         $includes = array(
             'actions',
@@ -65 +68 @@
         }
 
-        // Include these only if in admin
+        // Include these only if in admin.
         if ( is_admin() ) {
             $includes[] = 'admin';
@@ -88 +91 @@
         $bp = buddypress();
 
-        /** Component Globals *************************************************/
-
-        // Define a slug, as a fallback for backpat
+        /** Component Globals ************************************************
+         */
+
+        // Define a slug, as a fallback for backpat.
         if ( !defined( 'BP_MEMBERS_SLUG' ) ) {
             define( 'BP_MEMBERS_SLUG', $this->id );
         }
 
-        // Override any passed args
+        // Override any passed args.
         $args = array(
             'slug'            => BP_MEMBERS_SLUG,
@@ -110 +114 @@
         parent::setup_globals( $args );
 
-        /** Logged in user ****************************************************/
+        /** Logged in user ***************************************************
+         */
 
         // The core userdata of the user who is currently logged in.
         $bp->loggedin_user->userdata       = bp_core_get_core_userdata( bp_loggedin_user_id() );
 
-        // Fetch the full name for the logged in user
+        // Fetch the full name for the logged in user.
         $bp->loggedin_user->fullname       = isset( $bp->loggedin_user->userdata->display_name ) ? $bp->loggedin_user->userdata->display_name : '';
 
-        // Hits the DB on single WP installs so get this separately
+        // Hits the DB on single WP installs so get this separately.
         $bp->loggedin_user->is_super_admin = $bp->loggedin_user->is_site_admin = is_super_admin( bp_loggedin_user_id() );
 
-        // The domain for the user currently logged in. eg: http://example.com/members/andy
+        // The domain for the user currently logged in. eg: http://example.com/members/andy.
         $bp->loggedin_user->domain         = bp_core_get_user_domain( bp_loggedin_user_id() );
 
-        /** Displayed user ****************************************************/
-
-        // The core userdata of the user who is currently being displayed
+        /** Displayed user ***************************************************
+         */
+
+        // The core userdata of the user who is currently being displayed.
         $bp->displayed_user->userdata = bp_core_get_core_userdata( bp_displayed_user_id() );
 
-        // Fetch the full name displayed user
+        // Fetch the full name displayed user.
         $bp->displayed_user->fullname = isset( $bp->displayed_user->userdata->display_name ) ? $bp->displayed_user->userdata->display_name : '';
 
-        // The domain for the user currently being displayed
+        // The domain for the user currently being displayed.
         $bp->displayed_user->domain   = bp_core_get_user_domain( bp_displayed_user_id() );
 
-        /** Signup ************************************************************/
+        /** Signup ***********************************************************
+         */
 
         $bp->signup = new stdClass;
 
-        /** Profiles Fallback *************************************************/
+        /** Profiles Fallback ************************************************
+         */
 
         if ( ! bp_is_active( 'xprofile' ) ) {
@@ -156 +164 @@
         $bp = buddypress();
 
-        /** Default Profile Component *****************************************/
+        /** Default Profile Component ****************************************
+         */
 
         if ( defined( 'BP_DEFAULT_COMPONENT' ) && BP_DEFAULT_COMPONENT ) {
@@ -168 +177 @@
         }
 
-        /** Canonical Component Stack *****************************************/
+        /** Canonical Component Stack ****************************************
+         */
 
         if ( bp_displayed_user_id() ) {
@@ -185 +195 @@
             }
 
-            // Looking at the single member root/home, so assume the default
+            // Looking at the single member root/home, so assume the default.
             if ( ! bp_current_component() ) {
                 $bp->current_component = $bp->default_component;
 
-            // The canonical URL will not contain the default component
+            // The canonical URL will not contain the default component.
             } elseif ( bp_is_current_component( $bp->default_component ) && ! bp_current_action() ) {
                 unset( $bp->canonical_stack['component'] );
             }
 
-            // if we're on a spammer's profile page, only users with the 'bp_moderate' cap
-            // can view subpages on the spammer's profile
+            // If we're on a spammer's profile page, only users with the 'bp_moderate' cap
+            // can view subpages on the spammer's profile.
             //
             // users without the cap trying to access a spammer's subnav page will get
@@ -220 +230 @@
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
-        // Bail if XProfile component is active
+        // Bail if XProfile component is active.
         if ( bp_is_active( 'xprofile' ) ) {
             return;
         }
 
-        // Don't set up navigation if there's no member
+        // Don't set up navigation if there's no member.
         if ( ! is_user_logged_in() && ! bp_is_user() ) {
             return;
         }
 
-        // Determine user to use
+        // Determine user to use.
         if ( bp_displayed_user_domain() ) {
             $user_domain = bp_displayed_user_domain();
@@ -242 +252 @@
         $profile_link = trailingslashit( $user_domain . $slug );
 
-        // Setup the main navigation
+        // Setup the main navigation.
         $main_nav = array(
             'name'                => _x( 'Profile', 'Member profile main navigation', 'buddypress' ),
@@ -252 +262 @@
         );
 
-        // Setup the subnav items for the member profile
+        // Setup the subnav items for the member profile.
         $sub_nav[] = array(
             'name'            => _x( 'View', 'Member profile view', 'buddypress' ),
@@ -292 +302 @@
     public function setup_cache_groups() {
 
-        // Global groups
+        // Global groups.
         wp_cache_add_global_groups( array(
             'bp_last_activity',