Changeset 10163 for trunk/src/bp-xprofile/bp-xprofile-loader.php

Timestamp:

10/01/2015 04:18:13 AM (10 years ago)

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/bp-xprofile-loader.php (modified) (24 diffs)

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

@@ -16 +16 @@
 
     /**
-     * Profile field types
+     * Profile field types.
      *
      * @since 1.5.0
@@ -33 +33 @@
 
     /**
-     * Start the xprofile component creation process
+     * Start the xprofile component creation process.
      *
      * @since 1.5.0
@@ -51 +51 @@
 
     /**
-     * Include files
+     * Include files.
+     *
+     * @param array $includes
      */
     public function includes( $includes = array() ) {
@@ -76 +78 @@
 
     /**
-     * Setup globals
+     * Setup globals.
      *
      * The BP_XPROFILE_SLUG constant is deprecated, and only used here for
@@ -82 +84 @@
      *
      * @since 1.5.0
+     *
+     * @param array $args Array of globals to set up.
      */
     public function setup_globals( $args = array() ) {
         $bp = buddypress();
 
-        // Define a slug, if necessary
+        // Define a slug, if necessary.
         if ( !defined( 'BP_XPROFILE_SLUG' ) ) {
             define( 'BP_XPROFILE_SLUG', 'profile' );
@@ -93 +97 @@
         // Assign the base group and fullname field names to constants
         // to use in SQL statements.
-        // Defined conditionally to accommodate unit tests
+        // Defined conditionally to accommodate unit tests.
         if ( ! defined( 'BP_XPROFILE_BASE_GROUP_NAME' ) ) {
             define( 'BP_XPROFILE_BASE_GROUP_NAME', stripslashes( bp_core_get_root_option( 'avatar_default' ) ) );
@@ -113 +117 @@
         // 'option' is a special case. It is not a top-level field, so
         // does not have an associated BP_XProfile_Field_Type class,
-        // but it must be whitelisted
+        // but it must be whitelisted.
         $this->field_types[] = 'option';
 
-        // Register the visibility levels. See bp_xprofile_get_visibility_levels() to filter
+        // Register the visibility levels. See bp_xprofile_get_visibility_levels() to filter.
         $this->visibility_levels = array(
             'public' => array(
@@ -139 +143 @@
         }
 
-        // Tables
+        // Tables.
         $global_tables = array(
             'table_name_data'   => $bp->table_prefix . 'bp_xprofile_data',
@@ -168 +172 @@
      *
      * @global BuddyPress $bp The one true BuddyPress instance
+     *
+     * @param array $main_nav Array of main nav items to set up.
+     * @param array $sub_nav  Array of sub nav items to set up.
      */
     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();
@@ -184 +191 @@
         $profile_link = trailingslashit( $user_domain . $slug );
 
-        // Add 'Profile' to the main navigation
+        // Add 'Profile' to the main navigation.
         $main_nav = array(
             'name'                => _x( 'Profile', 'Profile header menu', 'buddypress' ),
@@ -194 +201 @@
         );
 
-        // Add the subnav items to the profile
+        // Add the subnav items to the profile.
         $sub_nav[] = array(
             'name'            => _x( 'View', 'Profile header sub menu', 'buddypress' ),
@@ -204 +211 @@
         );
 
-        // Edit Profile
+        // Edit Profile.
         $sub_nav[] = array(
             'name'            => _x( 'Edit','Profile header sub menu', 'buddypress' ),
@@ -215 +222 @@
         );
 
-        // Change Avatar
+        // Change Avatar.
         if ( buddypress()->avatar->show_avatars ) {
             $sub_nav[] = array(
@@ -242 +249 @@
 
         // The Settings > Profile nav item can only be set up after
-        // the Settings component has run its own nav routine
+        // the Settings component has run its own nav routine.
         add_action( 'bp_settings_setup_nav', array( $this, 'setup_settings_nav' ) );
 
@@ -261 +268 @@
         }
 
-        // Determine user to use
+        // Determine user to use.
         if ( bp_displayed_user_domain() ) {
             $user_domain = bp_displayed_user_domain();
@@ -270 +277 @@
         }
 
-        // Get the settings slug
+        // Get the settings slug.
         $settings_slug = bp_get_settings_slug();
 
@@ -285 +292 @@
 
     /**
-     * Set up the Toolbar
+     * Set up the Admin Bar.
+     *
+     * @param array $wp_admin_nav Admin Bar items.
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {
 
-        // Menus for logged in user
+        // Menus for logged in user.
         if ( is_user_logged_in() ) {
 
-            // Profile link
+            // Profile link.
             $profile_link = trailingslashit( bp_loggedin_user_domain() . bp_get_profile_slug() );
 
-            // Add the "Profile" sub menu
+            // Add the "Profile" sub menu.
             $wp_admin_nav[] = array(
                 'parent' => buddypress()->my_account_menu_id,
@@ -303 +312 @@
             );
 
-            // View Profile
+            // View Profile.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -311 +320 @@
             );
 
-            // Edit Profile
+            // Edit Profile.
             $wp_admin_nav[] = array(
                 'parent' => 'my-account-' . $this->id,
@@ -319 +328 @@
             );
 
-            // Edit Avatar
+            // Edit Avatar.
             if ( buddypress()->avatar->show_avatars ) {
                 $wp_admin_nav[] = array(
@@ -352 +361 @@
 
     /**
-     * Sets up the title for pages and <title>
+     * Sets up the title for pages and <title>.
      */
     public function setup_title() {
@@ -375 +384 @@
 
     /**
-     * Setup cache groups
+     * Setup cache groups.
      *
      * @since 2.2.0
@@ -381 +390 @@
     public function setup_cache_groups() {
 
-        // Global groups
+        // Global groups.
         wp_cache_add_global_groups( array(
             'bp_xprofile',
@@ -398 +407 @@
      *
      * @param array $wp_admin_nav The settings adminbar nav array.
+     *
      * @return array
      */
     public function setup_settings_admin_nav( $wp_admin_nav ) {
 
-        // Setup the logged in user variables
+        // Setup the logged in user variables.
         $settings_link = trailingslashit( bp_loggedin_user_domain() . bp_get_settings_slug() );
 
-        // Add the "Profile" subnav item
+        // Add the "Profile" subnav item.
         $wp_admin_nav[] = array(
             'parent' => 'my-account-' . buddypress()->settings->id,