Changeset 10322

Timestamp:

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

Author:

tw2113

Message:

More documentation cleanup for the Members component.

See #6402.

Location:

trunk/src/bp-members

Files:

• admin/bp-members-admin-classes.php (modified) (20 diffs)
• bp-members-actions.php (modified) (6 diffs)
• bp-members-activity.php (modified) (3 diffs)
• bp-members-admin.php (modified) (74 diffs)
• bp-members-adminbar.php (modified) (11 diffs)
• bp-members-filters.php (modified) (5 diffs)
• bp-members-functions.php (modified) (113 diffs)
• bp-members-loader.php (modified) (13 diffs)
• bp-members-screens.php (modified) (28 diffs)
• bp-members-template.php (modified) (36 diffs)
• bp-members-widgets.php (modified) (22 diffs)
• classes/class-bp-signup.php (modified) (27 diffs)

trunk/src/bp-members/admin/bp-members-admin-classes.php

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Members List Classes
+ * BuddyPress Members List Classes.
  *
  * @package BuddyPress
@@ -89 +89 @@
          * @since 2.0.0
          *
-         * @uses WP_Users_List_Table::get_views() to get the users views
+         * @uses WP_Users_List_Table::get_views() to get the users views.
          */
         public function get_views() {
                 $views = parent::get_views();
 
-                // Remove the 'current' class from the 'All' link
+                // Remove the 'current' class from the 'All' link.
                 $views['all']        = str_replace( 'class="current"', '', $views['all'] );
                 $views['registered'] = sprintf( '<a href="%1$s" class="current">%2$s</a>', esc_url( add_query_arg( 'page', 'bp-signups', bp_get_admin_url( 'users.php' ) ) ), sprintf( _x( 'Pending %s', 'signup users', 'buddypress' ), '<span class="count">(' . number_format_i18n( $this->signup_counts ) . ')</span>' ) );
@@ -109 +109 @@
          * @since 2.0.0
          *
-         * @param array $which
+         * @param array $which Current table nav item.
          */
         public function extra_tablenav( $which ) {
@@ -172 +172 @@
                         $link = false;
 
-                        // Specific case when BuddyPress is not network activated
+                        // Specific case when BuddyPress is not network activated.
                         if ( is_multisite() && current_user_can( 'manage_network_users') ) {
                                 $link = sprintf( '<a href="%1$s">%2$s</a>', esc_url( network_admin_url( 'settings.php'       ) ), esc_html__( 'Edit settings', 'buddypress' ) );
@@ -206 +206 @@
                 foreach ( $this->items as $userid => $signup_object ) {
 
-                        // Avoid a notice error appearing since 4.3.0
+                        // Avoid a notice error appearing since 4.3.0.
                         if ( isset( $signup_object->id ) ) {
                                 $signup_object->ID = $signup_object->id;
@@ -227 +227 @@
          * @param string      $role          Role to be assigned to user.
          * @param int         $numposts      Numper of posts.
-         *
-         * @return string
+         * @return void
          */
         public function single_row( $signup_object = null, $style = '', $role = '', $numposts = 0 ) {
@@ -260 +259 @@
                 $avatar = get_avatar( $signup_object->user_email, 32 );
 
-                // Activation email link
+                // Activation email link.
                 $email_link = add_query_arg(
                         array(
@@ -270 +269 @@
                 );
 
-                // Activate link
+                // Activate link.
                 $activate_link = add_query_arg(
                         array(
@@ -280 +279 @@
                 );
 
-                // Delete link
+                // Delete link.
                 $delete_link = add_query_arg(
                         array(
@@ -364 +363 @@
          *
          * @param object $signup_object Signup object instance.
-         *
-         * @return int
          */
         public function column_count_sent( $signup_object = null ) {
@@ -378 +375 @@
          * @param object|null $signup_object The signup data object.
          * @param string      $column_name   The column name.
-         *
          * @return string
          */
@@ -398 +394 @@
 
 if ( class_exists( 'WP_MS_Users_List_Table' ) ) :
+
 /**
  * List table class for signups network admin page.
@@ -415 +412 @@
 
         /**
-         * Constructor
+         * Constructor.
          *
          * @since 2.0.0
@@ -481 +478 @@
                 $views = parent::get_views();
 
-                // Remove the 'current' class from the 'All' link
+                // Remove the 'current' class from the 'All' link.
                 $views['all']        = str_replace( 'class="current"', '', $views['all'] );
                 $views['registered'] = sprintf( '<a href="%1$s" class="current">%2$s</a>', esc_url( add_query_arg( 'page', 'bp-signups', bp_get_admin_url( 'users.php' ) ) ), sprintf( _x( 'Pending %s', 'signup users', 'buddypress' ), '<span class="count">(' . number_format_i18n( $this->signup_counts ) . ')</span>' ) );
@@ -574 +571 @@
                 foreach ( $this->items as $userid => $signup_object ) {
 
-                        // Avoid a notice error appearing since 4.3.0
+                        // Avoid a notice error appearing since 4.3.0.
                         if ( isset( $signup_object->id ) ) {
                                 $signup_object->ID = $signup_object->id;
@@ -608 +605 @@
          * @param string $column_name   Current column name.
          * @param string $primary       Primary column name.
-         *
          * @return string
          */
@@ -639 +635 @@
                 $avatar = get_avatar( $signup_object->user_email, 32 );
 
-                // Activation email link
+                // Activation email link.
                 $email_link = add_query_arg(
                         array(
@@ -649 +645 @@
                 );
 
-                // Activate link
+                // Activate link.
                 $activate_link = add_query_arg(
                         array(
@@ -659 +655 @@
                 );
 
-                // Delete link
+                // Delete link.
                 $delete_link = add_query_arg(
                         array(
@@ -764 +760 @@
          * @param object|null $signup_object The signup data object.
          * @param string      $column_name   The column name.
-         *
          * @return string
          */

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

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Members Actions
+ * BuddyPress Members Actions.
  *
  * Action functions are exactly the same as screen functions, however they do not
@@ -28 +28 @@
 
         // Only super admins can currently spam users (but they can't spam
-        // themselves)
+        // themselves).
         if ( ! is_super_admin() || bp_is_my_profile() ) {
                 return;
         }
 
-        // Use displayed user if it's not yourself
+        // Use displayed user if it's not yourself.
         if ( empty( $user_id ) )
                 $user_id = bp_displayed_user_id();
@@ -39 +39 @@
         if ( bp_is_current_component( 'admin' ) && ( in_array( bp_current_action(), array( 'mark-spammer', 'unmark-spammer' ) ) ) ) {
 
-                // Check the nonce
+                // Check the nonce.
                 check_admin_referer( 'mark-unmark-spammer' );
 
-                // To spam or not to spam
+                // To spam or not to spam.
                 $status = bp_is_current_action( 'mark-spammer' ) ? 'spam' : 'ham';
 
-                // The heavy lifting
+                // The heavy lifting.
                 bp_core_process_spammer_status( $user_id, $status );
 
-                // Add feedback message. @todo - Error reporting
+                // Add feedback message. @todo - Error reporting.
                 if ( 'spam' == $status ) {
                         bp_core_add_message( __( 'User marked as spammer. Spam users are visible only to site admins.', 'buddypress' ) );
@@ -59 +59 @@
                 do_action( 'bp_core_action_set_spammer_status', bp_displayed_user_id(), $is_spam );
 
-                // Redirect back to where we came from
+                // Redirect back to where we came from.
                 bp_core_redirect( wp_get_referer() );
         }
 }
-// Unhooked in 1.6.0 - moved to settings
-//add_action( 'bp_actions', 'bp_core_action_set_spammer_status' );
+
+/*
+ * Unhooked in 1.6.0 - moved to settings.
+ * add_action( 'bp_actions', 'bp_core_action_set_spammer_status' );
+ */
 
 /**
@@ -78 +81 @@
         if ( bp_is_current_component( 'admin' ) && bp_is_current_action( 'delete-user' ) ) {
 
-                // Check the nonce
+                // Check the nonce.
                 check_admin_referer( 'delete-user' );
 
@@ -99 +102 @@
         }
 }
-// Unhooked in 1.6.0 - moved to settings
-//add_action( 'bp_actions', 'bp_core_action_delete_user' );
+
+/*
+ * Unhooked in 1.6.0 - moved to settings
+ * add_action( 'bp_actions', 'bp_core_action_delete_user' );
+ */
 
 /**

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

@@ -45 +45 @@
  * @param string $action   Static activity action.
  * @param object $activity Activity object.
- *
- * @return string
+ * @return string $action
  */
 function bp_members_format_activity_action_new_member( $action, $activity ) {
@@ -52 +51 @@
         $action   = sprintf( __( '%s became a registered member', 'buddypress' ), $userlink );
 
-        // Legacy filter - pass $user_id instead of $activity
+        // Legacy filter - pass $user_id instead of $activity.
         if ( has_filter( 'bp_core_activity_registered_member_action' ) ) {
                 $action = apply_filters( 'bp_core_activity_registered_member_action', $action, $activity->user_id );
@@ -72 +71 @@
  *
  * @param array $user Array of userdata passed to bp_core_activated_user hook.
- *
  * @return bool
  */

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

@@ -15 +15 @@
  * Load Members admin area.
  *
- * @package BuddyPress
- * @subpackage membersAdministration
- *
  * @since 2.0.0
  */
@@ -103 +100 @@
 
                 // Paths and URLs
-                $this->admin_dir = trailingslashit( $bp->plugin_dir  . 'bp-members/admin' ); // Admin path
-                $this->admin_url = trailingslashit( $bp->plugin_url  . 'bp-members/admin' ); // Admin URL
-                $this->css_url   = trailingslashit( $this->admin_url . 'css' ); // Admin CSS URL
-                $this->js_url    = trailingslashit( $this->admin_url . 'js'  ); // Admin CSS URL
-
-                // Capability depends on config
+                $this->admin_dir = trailingslashit( $bp->plugin_dir  . 'bp-members/admin' ); // Admin path.
+                $this->admin_url = trailingslashit( $bp->plugin_url  . 'bp-members/admin' ); // Admin URL.
+                $this->css_url   = trailingslashit( $this->admin_url . 'css' ); // Admin CSS URL.
+                $this->js_url    = trailingslashit( $this->admin_url . 'js'  ); // Admin CSS URL.
+
+                // Capability depends on config.
                 $this->capability = bp_core_do_network_admin() ? 'manage_network_users' : 'edit_users';
 
-                // The Edit Profile Screen id
+                // The Edit Profile Screen id.
                 $this->user_page = '';
 
-                // The Show Profile Screen id
+                // The Show Profile Screen id.
                 $this->user_profile = is_network_admin() ? 'users' : 'profile';
 
-                // The current user id
+                // The current user id.
                 $this->current_user_id = get_current_user_id();
 
-                // The user id being edited
+                // The user id being edited.
                 $this->user_id = 0;
 
-                // Is a member editing their own profile
+                // Is a member editing their own profile.
                 $this->is_self_profile = false;
 
-                // The screen ids to load specific css for
+                // The screen ids to load specific css for.
                 $this->screen_id = array();
 
-                // The stats metabox default position
+                // The stats metabox default position.
                 $this->stats_metabox = new StdClass();
 
-                // BuddyPress edit user's profile args
+                // BuddyPress edit user's profile args.
                 $this->edit_profile_args = array( 'page' => 'bp-profile-edit' );
                 $this->edit_profile_url  = '';
                 $this->edit_url          = '';
 
-                // Data specific to signups
+                // Data specific to signups.
                 $this->users_page   = '';
                 $this->signups_page = '';
@@ -143 +140 @@
                 $this->users_screen = bp_core_do_network_admin() ? 'users-network' : 'users';
 
-                // Specific config: BuddyPress is not network activated
+                // Specific config: BuddyPress is not network activated.
                 $this->subsite_activated = (bool) is_multisite() && ! bp_is_network_activated();
 
-                // When BuddyPress is not network activated, only Super Admin can moderate signups
+                // When BuddyPress is not network activated, only Super Admin can moderate signups.
                 if ( ! empty( $this->subsite_activated ) ) {
                         $this->capability = 'manage_network_users';
@@ -159 +156 @@
         private function setup_actions() {
 
-                /** Extended Profile **************************************************/
-
-                // Enqueue all admin JS and CSS
+                /** Extended Profile *************************************************
+                 */
+
+                // Enqueue all admin JS and CSS.
                 add_action( 'bp_admin_enqueue_scripts', array( $this, 'enqueue_scripts'   )        );
 
-                // Add some page specific output to the <head>
+                // Add some page specific output to the <head>.
                 add_action( 'bp_admin_head',            array( $this, 'admin_head'        ), 999   );
 
-                // Add menu item to all users menu
+                // Add menu item to all users menu.
                 add_action( 'admin_menu',               array( $this, 'admin_menus'       ), 5     );
                 add_action( 'network_admin_menu',       array( $this, 'admin_menus'       ), 5     );
                 add_action( 'user_admin_menu',          array( $this, 'user_profile_menu' ), 5     );
 
-                // Create the Profile Navigation (Profile/Extended Profile)
+                // Create the Profile Navigation (Profile/Extended Profile).
                 add_action( 'edit_user_profile',        array( $this, 'profile_nav'       ), 99, 1 );
                 add_action( 'show_user_profile',        array( $this, 'profile_nav'       ), 99, 1 );
 
-                // Editing users of a specific site
+                // Editing users of a specific site.
                 add_action( "admin_head-site-users.php", array( $this, 'profile_admin_head' ) );
 
-                // Add a row action to users listing
+                // Add a row action to users listing.
                 if ( bp_core_do_network_admin() ) {
                         add_filter( 'ms_user_row_actions',        array( $this, 'row_actions'                    ), 10, 2 );
@@ -186 +184 @@
                 }
 
-                // Add user row actions for single site
+                // Add user row actions for single site.
                 add_filter( 'user_row_actions', array( $this, 'row_actions' ), 10, 2 );
 
@@ -192 +190 @@
                 add_action( 'bp_members_admin_load', array( $this, 'process_member_type_update' ) );
 
-                /** Signups ***********************************************************/
+                /** Signups **********************************************************
+                 */
 
                 if ( is_admin() ) {
 
-                        // Filter non multisite user query to remove sign-up users
+                        // Filter non multisite user query to remove sign-up users.
                         if ( ! is_multisite() ) {
                                 add_action( 'pre_user_query', array( $this, 'remove_signups_from_user_query' ), 10, 1 );
                         }
 
-                        // Reorganise the views navigation in users.php and signups page
+                        // Reorganise the views navigation in users.php and signups page.
                         if ( current_user_can( $this->capability ) ) {
                                 add_filter( "views_{$this->users_screen}", array( $this, 'signup_filter_view'    ), 10, 1 );
@@ -226 +225 @@
                 $this->user_id = (int) get_current_user_id();
 
-                // We'll need a user ID when not on self profile
+                // We'll need a user ID when not on self profile.
                 if ( ! empty( $_GET['user_id'] ) ) {
                         $this->user_id = (int) $_GET['user_id'];
@@ -237 +236 @@
          * Can the current user edit the one displayed.
          *
-         * self profile editing / or bp_moderate check.
+         * Self profile editing / or bp_moderate check.
          * This might be replaced by more granular capabilities
          * in the future.
@@ -250 +249 @@
                 $retval = false;
 
-                // Bail if no user ID was passed
+                // Bail if no user ID was passed.
                 if ( empty( $user_id ) ) {
                         return $retval;
                 }
 
-                // Member can edit if they are viewing their own profile
+                // Member can edit if they are viewing their own profile.
                 if ( $this->current_user_id === $user_id ) {
                         $retval = true;
 
-                // Trust the 'bp_moderate' capability
+                // Trust the 'bp_moderate' capability.
                 } else {
                         $retval = bp_current_user_can( 'bp_moderate' );
@@ -276 +275 @@
         private function get_user_notice() {
 
-                // Setup empty notice for return value
+                // Setup empty notice for return value.
                 $notice = array();
 
-                // Updates
+                // Updates.
                 if ( ! empty( $_REQUEST['updated'] ) ) {
                         switch ( $_REQUEST['updated'] ) {
@@ -309 +308 @@
                 }
 
-                // Errors
+                // Errors.
                 if ( ! empty( $_REQUEST['error'] ) ) {
                         switch ( $_REQUEST['error'] ) {
@@ -363 +362 @@
         public function user_profile_menu() {
 
-                // Setup the hooks array
+                // Setup the hooks array.
                 $hooks = array();
 
-                // Add the faux "Edit Profile" submenu page
+                // Add the faux "Edit Profile" submenu page.
                 $hooks['user'] = $this->user_page = add_submenu_page(
                         'profile.php',
@@ -376 +375 @@
                 );
 
-                // Setup the screen ID's
+                // Setup the screen ID's.
                 $this->screen_id = array(
                         $this->user_page    . '-user',
@@ -382 +381 @@
                 );
 
-                // Loop through new hooks and add method actions
+                // Loop through new hooks and add method actions.
                 foreach ( $hooks as $key => $hook ) {
                         add_action( "load-{$hook}", array( $this, $key . '_admin_load' ) );
                 }
 
-                // Add the profile_admin_head method to proper admin_head actions
+                // Add the profile_admin_head method to proper admin_head actions.
                 add_action( "admin_head-{$this->user_page}", array( $this, 'profile_admin_head' ) );
                 add_action( "admin_head-profile.php",        array( $this, 'profile_admin_head' ) );
@@ -401 +400 @@
         public function admin_menus() {
 
-                // Setup the hooks array
+                // Setup the hooks array.
                 $hooks = array();
 
-                // Manage user's profile
+                // Manage user's profile.
                 $hooks['user'] = $this->user_page = add_submenu_page(
                         $this->user_profile . '.php',
@@ -414 +413 @@
                 );
 
-                // Only show sign-ups where they belong
+                // Only show sign-ups where they belong.
                 if ( ! is_multisite() || is_network_admin() ) {
 
-                        // Manage signups
+                        // Manage signups.
                         $hooks['signups'] = $this->signups_page = add_users_page(
                                 __( 'Manage Signups',  'buddypress' ),
@@ -431 +430 @@
                 $this->users_page  = 'users';
 
-                // Self profile check is needed for this pages
+                // Self profile check is needed for this pages.
                 $page_head = array(
                         $edit_page        . '.php',
@@ -439 +438 @@
                 );
 
-                // Append '-network' to each array item if in network admin
+                // Append '-network' to each array item if in network admin.
                 if ( is_network_admin() ) {
                         $edit_page          .= '-network';
@@ -448 +447 @@
                 }
 
-                // Setup the screen ID's
+                // Setup the screen ID's.
                 $this->screen_id = array(
                         $edit_page,
@@ -455 +454 @@
                 );
 
-                // Loop through new hooks and add method actions
+                // Loop through new hooks and add method actions.
                 foreach ( $hooks as $key => $hook ) {
                         add_action( "load-{$hook}", array( $this, $key . '_admin_load' ) );
                 }
 
-                // Add the profile_admin_head method to proper admin_head actions
+                // Add the profile_admin_head method to proper admin_head actions.
                 foreach ( $page_head as $head ) {
                         add_action( "admin_head-{$head}", array( $this, 'profile_admin_head' ) );
@@ -478 +477 @@
                         $this->is_self_profile = true;
 
-                // Is the user attempting to edit their own profile
+                // Is the user attempting to edit their own profile.
                 } elseif ( isset( $_GET['user_id' ] ) || ( isset( $_GET['page'] ) && ( 'bp-profile-edit' === $_GET['page'] ) ) ) {
                         $this->is_self_profile = (bool) ( $this->get_user_id() === $this->current_user_id );
@@ -490 +489 @@
                 }
 
-                // Editing your own profile, so recheck some vars
+                // Editing your own profile, so recheck some vars.
                 if ( true === $this->is_self_profile ) {
 
-                        // Use profile.php as the edit page
+                        // Use profile.php as the edit page.
                         $edit_page = 'profile.php';
 
-                        // Set profile.php as the parent & sub files to correct the menu nav
+                        // Set profile.php as the parent & sub files to correct the menu nav.
                         if ( is_blog_admin() || is_user_admin() ) {
                                 $parent_file  = 'profile.php';
@@ -502 +501 @@
                         }
 
-                // Not editing yourself, so use user-edit.php
+                // Not editing yourself, so use user-edit.php.
                 } else {
                         $edit_page = 'user-edit.php';
@@ -566 +565 @@
                 }
 
-                // Only load JavaScript for BuddyPress profile
+                // Only load JavaScript for BuddyPress profile.
                 if ( get_current_screen()->id == $this->user_page ) {
                         $js = $this->js_url . "admin{$min}.js";
@@ -599 +598 @@
          * @param object|null $user   User to create profile navigation for.
          * @param string      $active Which profile to highlight.
-         *
          * @return string
          */
         public function profile_nav( $user = null, $active = 'WordPress' ) {
 
-                // Bail if no user ID exists here
+                // Bail if no user ID exists here.
                 if ( empty( $user->ID ) ) {
                         return;
                 }
 
-                // Add the user ID to query arguments when not editing yourself
+                // Add the user ID to query arguments when not editing yourself.
                 if ( false === $this->is_self_profile ) {
                         $query_args = array( 'user_id' => $user->ID );
@@ -616 +614 @@
                 }
 
-                // Conditionally add a referer if it exists in the existing request
+                // Conditionally add a referer if it exists in the existing request.
                 if ( ! empty( $_REQUEST['wp_http_referer'] ) ) {
                         $query_args['wp_http_referer'] = urlencode( stripslashes_deep( $_REQUEST['wp_http_referer'] ) );
                 }
 
-                // Setup the two distinct "edit" URL's
+                // Setup the two distinct "edit" URL's.
                 $community_url = add_query_arg( $query_args, $this->edit_profile_url );
                 $wordpress_url = add_query_arg( $query_args, $this->edit_url         );
@@ -662 +660 @@
         public function user_admin_load() {
 
-                // Get the user ID
+                // Get the user ID.
                 $user_id = $this->get_user_id();
 
-                // can current user edit this profile ?
+                // Can current user edit this profile?
                 if ( ! $this->member_can_edit( $user_id ) ) {
                         wp_die( __( 'You cannot edit the requested user.', 'buddypress' ) );
                 }
 
-                // Build redirection URL
+                // Build redirection URL.
                 $redirect_to = remove_query_arg( array( 'action', 'error', 'updated', 'spam', 'ham', 'delete_avatar' ), $_SERVER['REQUEST_URI'] );
                 $doaction    = ! empty( $_REQUEST['action'] ) ? $_REQUEST['action'] : false;
@@ -701 +699 @@
                 $allowed_actions = apply_filters( 'bp_members_admin_allowed_actions', array( 'update', 'delete_avatar', 'spam', 'ham' ) );
 
-                // Prepare the display of the Community Profile screen
+                // Prepare the display of the Community Profile screen.
                 if ( ! in_array( $doaction, $allowed_actions ) ) {
                         add_screen_option( 'layout_columns', array( 'default' => 2, 'max' => 2, ) );
@@ -714 +712 @@
                         ) );
 
-                        // Help panel - sidebar links
+                        // Help panel - sidebar links.
                         get_current_screen()->set_help_sidebar(
                                 '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
@@ -731 +729 @@
                         );
 
-                        // In case xprofile is not active
+                        // In case xprofile is not active.
                         $this->stats_metabox->context  = 'normal';
                         $this->stats_metabox->priority = 'core';
@@ -748 +746 @@
                         do_action_ref_array( 'bp_members_admin_xprofile_metabox', array( $user_id, get_current_screen()->id, $this->stats_metabox ) );
 
-                        // If xProfile is inactive, difficult to know what's profile we're on
+                        // If xProfile is inactive, difficult to know what's profile we're on.
                         if ( 'normal' === $this->stats_metabox->context ) {
                                 $display_name = bp_core_get_user_displayname( $user_id );
@@ -755 +753 @@
                         }
 
-                        // User Stat metabox
+                        // User Stat metabox.
                         add_meta_box(
                                 'bp_members_admin_user_stats',
@@ -793 +791 @@
                         do_action( 'bp_members_admin_user_metaboxes', $this->is_self_profile, $user_id );
 
-                        // Enqueue JavaScript files
+                        // Enqueue JavaScript files.
                         wp_enqueue_script( 'postbox'   );
                         wp_enqueue_script( 'dashboard' );
 
-                // Spam or Ham user
+                // Spam or Ham user.
                 } elseif ( in_array( $doaction, array( 'spam', 'ham' ) ) && empty( $this->is_self_profile ) ) {
 
@@ -810 +808 @@
                         bp_core_redirect( $redirect_to );
 
-                // Update other stuff once above ones are done
+                // Update other stuff once above ones are done.
                 } else {
                         $this->redirect = $redirect_to;
@@ -841 +839 @@
                 }
 
-                // Get the user ID
+                // Get the user ID.
                 $user_id = $this->get_user_id();
                 $user    = get_user_to_edit( $user_id );
 
-                // Construct title
+                // Construct title.
                 if ( true === $this->is_self_profile ) {
                         $title = __( 'Profile',   'buddypress' );
@@ -852 +850 @@
                 }
 
-                // Construct URL for form
+                // Construct URL for form.
                 $request_url     = remove_query_arg( array( 'action', 'error', 'updated', 'spam', 'ham' ), $_SERVER['REQUEST_URI'] );
                 $form_action_url = add_query_arg( 'action', 'update', $request_url );
@@ -860 +858 @@
                 }
 
-                // Prepare notice for admin
+                // Prepare notice for admin.
                 $notice = $this->get_user_notice();
 
@@ -947 +945 @@
         public function user_admin_status_metabox( $user = null ) {
 
-                // Bail if no user id or if the user has not activated their account yet
+                // Bail if no user id or if the user has not activated their account yet.
                 if ( empty( $user->ID ) ) {
                         return;
                 }
 
-                // Bail if user has not been activated yet (how did you get here?)
+                // Bail if user has not been activated yet (how did you get here?).
                 if ( isset( $user->user_status ) && ( 2 == $user->user_status ) ) : ?>
 
@@ -966 +964 @@
                                         <?php
 
-                                        // Get the spam status once here to compare against below
+                                        // Get the spam status once here to compare against below.
                                         $is_spammer = bp_is_user_spammer( $user->ID );
 
@@ -989 +987 @@
                                                 <?php
 
-                                                // translators: Publish box date format, see http://php.net/date
+                                                // Translators: Publish box date format, see http://php.net/date.
                                                 $datef = __( 'M j, Y @ G:i', 'buddypress' );
                                                 $date  = date_i18n( $datef, strtotime( $user->user_registered ) );
@@ -1036 +1034 @@
         public function user_admin_stats_metabox( $user = null ) {
 
-                // Bail if no user ID
+                // Bail if no user ID.
                 if ( empty( $user->ID ) ) {
                         return;
                 }
 
-                // If account is not activated last activity is the time user registered
+                // If account is not activated last activity is the time user registered.
                 if ( isset( $user->user_status ) && 2 == $user->user_status ) {
                         $last_active = $user->user_registered;
 
-                // Account is activated, getting user's last activity
+                // Account is activated, getting user's last activity.
                 } else {
                         $last_active = bp_get_user_last_activity( $user->ID );
@@ -1057 +1055 @@
 
                         <?php
-                        // Loading other stats only if user has activated their account
+                        // Loading other stats only if user has activated their account.
                         if ( empty( $user->user_status ) ) {
 
@@ -1148 +1146 @@
          * @param array|string $actions WordPress row actions (edit, delete).
          * @param object       $user    The object for the user row.
-         *
          * @return array Merged actions.
          */
         public function row_actions( $actions = '', $user = null ) {
 
-                // Bail if no user ID
+                // Bail if no user ID.
                 if ( empty( $user->ID ) ) {
                         return;
                 }
 
-                // Setup args array
+                // Setup args array.
                 $args = array();
 
-                // Add the user ID if it's not for the current user
+                // Add the user ID if it's not for the current user.
                 if ( $user->ID !== $this->current_user_id ) {
                         $args['user_id'] = $user->ID;
                 }
 
-                // Add the referer
+                // Add the referer.
                 $args['wp_http_referer'] = urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) );
 
-                // Add the "Extended" link if the current user can edit this user
+                // Add the "Extended" link if the current user can edit this user.
                 if ( current_user_can( 'edit_user', $user->ID ) || bp_current_user_can( 'bp_moderate' ) ) {
 
-                        // Add query args and setup the Extended link
+                        // Add query args and setup the Extended link.
                         $edit_profile      = add_query_arg( $args, $this->edit_profile_url );
                         $edit_profile_link = sprintf( '<a href="%1$s">%2$s</a>',  esc_url( $edit_profile ), esc_html__( 'Extended', 'buddypress' ) );
@@ -1178 +1175 @@
                         /**
                          * Check the edit action is available
-                         * and preserve the order edit | profile | remove/delete
+                         * and preserve the order edit | profile | remove/delete.
                          */
                         if ( ! empty( $actions['edit'] ) ) {
@@ -1189 +1186 @@
                                 );
 
-                        // If not available simply add the edit profile action
+                        // If not available simply add the edit profile action.
                         } else {
                                 $new_edit_actions = array( 'edit-profile' => $edit_profile_link );
@@ -1219 +1216 @@
          * @param string $url          Profile URL.
          * @param int    $user_id      User ID.
-         *
          * @return string
          */
@@ -1245 +1241 @@
          * @since 2.0.0
          *
-         * @param int    $value
-         * @param string $option
-         * @param int    $new_value
-         *
+         * @param int    $value     Value for signup option.
+         * @param string $option    Value for the option key.
+         * @param int    $new_value Value for the saved option.
          * @return int The pagination preferences.
          */
@@ -1256 +1251 @@
                 }
 
-                // Per page
+                // Per page.
                 $new_value = (int) $new_value;
                 if ( $new_value < 1 || $new_value > 999 ) {
@@ -1274 +1269 @@
          *
          * @param WP_User_Query $query The users query.
-         *
          * @return WP_User_Query The users query without the signups.
          */
@@ -1280 +1274 @@
                 global $wpdb;
 
-                // Bail if this is an ajax request
+                // Bail if this is an ajax request.
                 if ( defined( 'DOING_AJAX' ) ) {
                         return;
                 }
 
-                // Bail if updating BuddyPress
+                // Bail if updating BuddyPress.
                 if ( bp_is_update() ) {
                         return;
                 }
 
-                // Bail if there is no current admin screen
+                // Bail if there is no current admin screen.
                 if ( ! function_exists( 'get_current_screen' ) || ! get_current_screen() ) {
                         return;
                 }
 
-                // Get current screen
+                // Get current screen.
                 $current_screen = get_current_screen();
 
-                // Bail if not on a users page
+                // Bail if not on a users page.
                 if ( ! isset( $current_screen->id ) || $this->users_page !== $current_screen->id ) {
                         return;
                 }
 
-                // Bail if already querying by an existing role
+                // Bail if already querying by an existing role.
                 if ( ! empty( $query->query_vars['role'] ) ) {
                         return;
@@ -1317 +1311 @@
          *
          * @param array $views WP List Table views.
-         *
          * @return array The views with the signup view added.
          */
         public function signup_filter_view( $views = array() ) {
 
-                // Remove the 'current' class from All if we're on the signups view
+                // Remove the 'current' class from All if we're on the signups view.
                 if ( $this->signups_page == get_current_screen()->id ) {
                         $views['all'] = str_replace( 'class="current"', '', $views['all'] );
@@ -1346 +1339 @@
          * @param string $class    The name of the class to use.
          * @param string $required The parent class.
-         *
-         * @return WP_List_Table    The List table.
+         * @return WP_List_Table The List table.
          */
         public static function get_list_table_class( $class = '', $required = '' ) {
@@ -1376 +1368 @@
                 global $bp_members_signup_list_table;
 
-                // Build redirection URL
+                // Build redirection URL.
                 $redirect_to = remove_query_arg( array( 'action', 'error', 'updated', 'activated', 'notactivated', 'deleted', 'notdeleted', 'resent', 'notresent', 'do_delete', 'do_resend', 'do_activate', '_wpnonce', 'signup_ids' ), $_SERVER['REQUEST_URI'] );
                 $doaction    = bp_admin_list_table_current_bulk_action();
@@ -1399 +1391 @@
                 $allowed_actions = apply_filters( 'bp_signups_admin_allowed_actions', array( 'do_delete', 'do_activate', 'do_resend' ) );
 
-                // Prepare the display of the Community Profile screen
+                // Prepare the display of the Community Profile screen.
                 if ( ! in_array( $doaction, $allowed_actions ) || ( -1 == $doaction ) ) {
 
@@ -1408 +1400 @@
                         }
 
-                        // per_page screen option
+                        // The per_page screen option.
                         add_screen_option( 'per_page', array( 'label' => _x( 'Pending Accounts', 'Pending Accounts per page (screen options)', 'buddypress' ) ) );
 
@@ -1432 +1424 @@
                         ) );
 
-                        // Help panel - sidebar links
+                        // Help panel - sidebar links.
                         get_current_screen()->set_help_sidebar(
                                 '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
@@ -1442 +1434 @@
                         }
 
-                        // Handle resent activation links
+                        // Handle resent activation links.
                         if ( 'do_resend' == $doaction ) {
 
-                                // nonce check
+                                // Nonce check.
                                 check_admin_referer( 'signups_resend' );
 
@@ -1469 +1461 @@
                                 bp_core_redirect( $redirect_to );
 
-                        // Handle activated accounts
+                        // Handle activated accounts.
                         } elseif ( 'do_activate' == $doaction ) {
 
-                                // nonce check
+                                // Nonce check.
                                 check_admin_referer( 'signups_activate' );
 
@@ -1496 +1488 @@
                                 bp_core_redirect( $redirect_to );
 
-                        // Handle sign-ups delete
+                        // Handle sign-ups delete.
                         } elseif ( 'do_delete' == $doaction ) {
 
-                                // nonce check
+                                // Nonce check.
                                 check_admin_referer( 'signups_delete' );
 
@@ -1523 +1515 @@
                                 bp_core_redirect( $redirect_to );
 
-                        // Plugins can update other stuff from here
+                        // Plugins can update other stuff from here.
                         } else {
                                 $this->redirect = $redirect_to;
@@ -1550 +1542 @@
         public function signups_display_errors() {
 
-                // Look for sign-up errors
+                // Look for sign-up errors.
                 $errors = get_transient( '_bp_admin_signups_errors' );
 
-                // Bail if no activation errors
+                // Bail if no activation errors.
                 if ( empty( $errors ) ) {
                         return;
                 }
 
-                // Loop through errors and display them
+                // Loop through errors and display them.
                 foreach ( $errors as $error ) : ?>
 
@@ -1565 +1557 @@
                 <?php endforeach;
 
-                // Delete the redirect transient
+                // Delete the redirect transient.
                 delete_transient( '_bp_admin_signups_errors' );
         }
@@ -1578 +1570 @@
         private function get_signup_notice() {
 
-                // Setup empty notice for return value
+                // Setup empty notice for return value.
                 $notice = array();
 
-                // Updates
+                // Updates.
                 if ( ! empty( $_REQUEST['updated'] ) ) {
                         switch ( $_REQUEST['updated'] ) {
@@ -1688 +1680 @@
                 }
 
-                // Errors
+                // Errors.
                 if ( ! empty( $_REQUEST['error'] ) ) {
                         switch ( $_REQUEST['error'] ) {
@@ -1733 +1725 @@
                 $doaction = bp_admin_list_table_current_bulk_action();
 
-                // Prepare notices for admin
+                // Prepare notices for admin.
                 $notice = $this->get_signup_notice();
 
-                // Display notices
+                // Display notices.
                 if ( ! empty( $notice ) ) :
                         if ( 'updated' === $notice['class'] ) : ?>
@@ -1760 +1752 @@
                 <?php endif;
 
-                // Show the proper screen
+                // Show the proper screen.
                 switch ( $doaction ) {
                         case 'activate' :
@@ -1788 +1780 @@
                 $usersearch = ! empty( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : '';
 
-                // Prepare the group items for display
+                // Prepare the group items for display.
                 $bp_members_signup_list_table->prepare_items();
 
@@ -1843 +1835 @@
                         </h2>
 
-                        <?php // Display each signups on its own row ?>
+                        <?php // Display each signups on its own row. ?>
                         <?php $bp_members_signup_list_table->views(); ?>
 
@@ -1864 +1856 @@
          *
          * @param string $action Delete, activate, or resend activation link.
-         *
          * @return string
          */
@@ -1872 +1863 @@
                 }
 
-                // Get the user IDs from the URL
+                // Get the user IDs from the URL.
                 $ids = false;
                 if ( ! empty( $_POST['allsignups'] ) ) {
@@ -1885 +1876 @@
 
                 // Query for signups, and filter out those IDs that don't
-                // correspond to an actual signup
+                // correspond to an actual signup.
                 $signups_query = BP_Signup::get( array(
                         'include' => $ids,
@@ -1893 +1884 @@
                 $signup_ids = wp_list_pluck( $signups, 'signup_id' );
 
-                // Set up strings
+                // Set up strings.
                 switch ( $action ) {
                         case 'delete' :
@@ -1923 +1914 @@
                 }
 
-                // These arguments are added to all URLs
+                // These arguments are added to all URLs.
                 $url_args = array( 'page' => 'bp-signups' );
 
-                // These arguments are only added when performing an action
+                // These arguments are only added when performing an action.
                 $action_args = array(
                         'action'     => 'do_' . $action,
@@ -1987 +1978 @@
         }
 }
-endif; // class_exists check
-
-// Load the BP Members admin
+endif; // End class_exists check.
+
+// Load the BP Members admin.
 add_action( 'bp_init', array( 'BP_Members_Admin', 'register_members_admin' ) );

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

@@ -17 +17 @@
  * @since 1.6.0
  *
- * @todo Deprecate WP 3.2 Toolbar compatibility when we drop 3.2 support
+ * @todo Deprecate WP 3.2 Toolbar compatibility when we drop 3.2 support.
  */
 function bp_members_admin_bar_my_account_menu() {
         global $wp_admin_bar;
 
-        // Bail if this is an ajax request
+        // Bail if this is an ajax request.
         if ( defined( 'DOING_AJAX' ) )
                 return;
 
-        // Logged in user
+        // Logged in user.
         if ( is_user_logged_in() ) {
 
                 $bp = buddypress();
 
-                // Stored in the global so we can add menus easily later on
+                // Stored in the global so we can add menus easily later on.
                 $bp->my_account_menu_id = 'my-account-buddypress';
 
-                // Create the main 'My Account' menu
+                // Create the main 'My Account' menu.
                 $wp_admin_bar->add_menu( array(
                         'id'     => $bp->my_account_menu_id,
@@ -44 +44 @@
                 ) ) );
 
-        // Show login and sign-up links
+        // Show login and sign-up links.
         } elseif ( !empty( $wp_admin_bar ) ) {
 
                 add_filter ( 'show_admin_bar', '__return_true' );
 
-                // Create the main 'My Account' menu
+                // Create the main 'My Account' menu.
                 $wp_admin_bar->add_menu( array(
                         'id'    => 'bp-login',
@@ -56 +56 @@
                 ) );
 
-                // Sign up
+                // Sign up.
                 if ( bp_get_signup_allowed() ) {
                         $wp_admin_bar->add_menu( array(
@@ -76 +76 @@
         global $wp_admin_bar;
 
-        // Only show if viewing a user
+        // Only show if viewing a user.
         if ( !bp_is_user() )
                 return false;
 
-        // Don't show this menu to non site admins or if you're viewing your own profile
+        // Don't show this menu to non site admins or if you're viewing your own profile.
         if ( !current_user_can( 'edit_users' ) || bp_is_my_profile() )
                 return false;
@@ -86 +86 @@
         $bp = buddypress();
 
-        // Unique ID for the 'My Account' menu
+        // Unique ID for the 'My Account' menu.
         $bp->user_admin_menu_id = 'user-admin';
 
-        // Add the top-level User Admin button
+        // Add the top-level User Admin button.
         $wp_admin_bar->add_menu( array(
                 'id'    => $bp->user_admin_menu_id,
@@ -97 +97 @@
 
         if ( bp_is_active( 'xprofile' ) ) {
-                // User Admin > Edit this user's profile
+                // User Admin > Edit this user's profile.
                 $wp_admin_bar->add_menu( array(
                         'parent' => $bp->user_admin_menu_id,
@@ -105 +105 @@
                 ) );
 
-                // User Admin > Edit this user's avatar
+                // User Admin > Edit this user's avatar.
                 if ( buddypress()->avatar->show_avatars ) {
                         $wp_admin_bar->add_menu( array(
@@ -115 +115 @@
                 }
 
-                // User Admin > Edit this user's cover image
+                // User Admin > Edit this user's cover image.
                 if ( bp_displayed_user_use_cover_image_header() ) {
                         $wp_admin_bar->add_menu( array(
@@ -128 +128 @@
 
         if ( bp_is_active( 'settings' ) ) {
-                // User Admin > Spam/unspam
+                // User Admin > Spam/unspam.
                 $wp_admin_bar->add_menu( array(
                         'parent' => $bp->user_admin_menu_id,
@@ -136 +136 @@
                 ) );
 
-                // User Admin > Delete Account
+                // User Admin > Delete Account.
                 $wp_admin_bar->add_menu( array(
                         'parent' => $bp->user_admin_menu_id,
@@ -153 +153 @@
  *
  * @since 1.5.0
+ *
+ * @return bool
  */
 function bp_members_admin_bar_notifications_menu() {
 
-        // Bail if notifications is not active
+        // Bail if notifications is not active.
         if ( ! bp_is_active( 'notifications' ) ) {
                 return false;

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

@@ -33 +33 @@
 function bp_members_signup_sanitization() {
 
-        // Filters on sign-up fields
+        // Filters on sign-up fields.
         $fields = array (
                 'bp_get_signup_username_value',
@@ -44 +44 @@
         );
 
-        // Add the filters to each field
+        // Add the filters to each field.
         foreach( $fields as $filter ) {
                 add_filter( $filter, 'esc_html',       1 );
@@ -51 +51 @@
         }
 
-        // Sanitize email
+        // Sanitize email.
         add_filter( 'bp_get_signup_email_value', 'sanitize_email' );
 }
@@ -66 +66 @@
  * @since 2.1.0
  *
- * @param array $illegal_names
- *
+ * @param array $illegal_names Array of illiegal names.
  * @return array $illegal_names
  */
@@ -102 +101 @@
  * @param string $url     WP profile edit URL.
  * @param int    $user_id ID of the user.
- * @param string $scheme
- *
+ * @param string $scheme  Scheme to use.
  * @return string
  */
 function bp_members_edit_profile_url( $url, $user_id, $scheme = 'admin' ) {
 
-        // If xprofile is active, use profile domain link
+        // If xprofile is active, use profile domain link.
         if ( ! is_admin() && bp_is_active( 'xprofile' ) ) {
                 $profile_link = trailingslashit( bp_core_get_user_domain( $user_id ) . bp_get_profile_slug() . '/edit' );
 
-        // Default to $url
+        // Default to $url.
         } else {
                 $profile_link = $url;

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

@@ -39 +39 @@
         $bp = buddypress();
 
-        // No custom members slug
+        // No custom members slug.
         if ( !defined( 'BP_MEMBERS_SLUG' ) ) {
                 if ( !empty( $bp->pages->members ) ) {
@@ -48 +48 @@
         }
 
-        // No custom registration slug
+        // No custom registration slug.
         if ( !defined( 'BP_REGISTER_SLUG' ) ) {
                 if ( !empty( $bp->pages->register ) ) {
@@ -57 +57 @@
         }
 
-        // No custom activation slug
+        // No custom activation slug.
         if ( !defined( 'BP_ACTIVATION_SLUG' ) ) {
                 if ( !empty( $bp->pages->activate ) ) {
@@ -98 +98 @@
 function bp_core_get_users( $args = '' ) {
 
-        // Parse the user query arguments
+        // Parse the user query arguments.
         $r = bp_parse_args( $args, array(
-                'type'                => 'active',     // active, newest, alphabetical, random or popular
-                'user_id'             => false,        // Pass a user_id to limit to only friend connections for this user
-                'exclude'             => false,        // Users to exclude from results
-                'search_terms'        => false,        // Limit to users that match these search terms
-                'meta_key'            => false,        // Limit to users who have this piece of usermeta
-                'meta_value'          => false,        // With meta_key, limit to users where usermeta matches this value
+                'type'                => 'active',     // Active, newest, alphabetical, random or popular.
+                'user_id'             => false,        // Pass a user_id to limit to only friend connections for this user.
+                'exclude'             => false,        // Users to exclude from results.
+                'search_terms'        => false,        // Limit to users that match these search terms.
+                'meta_key'            => false,        // Limit to users who have this piece of usermeta.
+                'meta_value'          => false,        // With meta_key, limit to users where usermeta matches this value.
                 'member_type'         => '',
                 'member_type__in'     => '',
                 'member_type__not_in' => '',
-                'include'             => false,        // Pass comma separated list of user_ids to limit to only these users
-                'per_page'            => 20,           // The number of results to return per page
-                'page'                => 1,            // The page to return if limiting per page
-                'populate_extras'     => true,         // Fetch the last active, where the user is a friend, total friend count, latest update
-                'count_total'         => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false
+                'include'             => false,        // Pass comma separated list of user_ids to limit to only these users.
+                'per_page'            => 20,           // The number of results to return per page.
+                'page'                => 1,            // The page to return if limiting per page.
+                'populate_extras'     => true,         // Fetch the last active, where the user is a friend, total friend count, latest update.
+                'count_total'         => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false.
         ), 'core_get_users' );
 
@@ -131 +131 @@
                 );
 
-        // Default behavior as of BuddyPress 1.7
+        // Default behavior as of BuddyPress 1.7.0.
         } else {
 
@@ -161 +161 @@
  * @param string|bool $user_nicename Optional. user_nicename of the user.
  * @param string|bool $user_login    Optional. user_login of the user.
- *
  * @return string
  */
@@ -200 +199 @@
  *
  * @param int $user_id The ID of the user.
- *
  * @return array
  */
@@ -231 +229 @@
  *
  * @param string $user_login user_login of the user being queried.
- *
  * @return int
  */
@@ -244 +241 @@
  *
  * @param string $username user_login to check.
- *
  * @return int|null The ID of the matched user on success, null on failure.
  */
@@ -271 +267 @@
  *
  * @param string $user_nicename user_nicename to check.
- *
  * @return int|null The ID of the matched user on success, null on failure.
  */
@@ -301 +296 @@
  * @param string|bool $user_nicename Optional. user_nicename of user being checked.
  * @param string|bool $user_login    Optional. user_login of user being checked.
- *
  * @return string|bool The username of the matched user, or false.
  */
@@ -307 +301 @@
         $bp = buddypress();
 
-        // Check cache for user nicename
+        // Check cache for user nicename.
         $username = wp_cache_get( 'bp_user_username_' . $user_id, 'bp' );
         if ( false === $username ) {
 
-                // Cache not found so prepare to update it
+                // Cache not found so prepare to update it.
                 $update_cache = true;
 
-                // Nicename and login were not passed
+                // Nicename and login were not passed.
                 if ( empty( $user_nicename ) && empty( $user_login ) ) {
 
-                        // User ID matches logged in user
+                        // User ID matches logged in user.
                         if ( bp_loggedin_user_id() == $user_id ) {
                                 $userdata = &$bp->loggedin_user->userdata;
 
-                        // User ID matches displayed in user
+                        // User ID matches displayed in user.
                         } elseif ( bp_displayed_user_id() == $user_id ) {
                                 $userdata = &$bp->displayed_user->userdata;
 
-                        // No user ID match
+                        // No user ID match.
                         } else {
                                 $userdata = false;
                         }
 
-                        // No match so go dig
+                        // No match so go dig.
                         if ( empty( $userdata ) ) {
 
-                                // User not found so return false
+                                // User not found so return false.
                                 if ( !$userdata = bp_core_get_core_userdata( $user_id ) ) {
                                         return false;
@@ -339 +333 @@
                         }
 
-                        // Update the $user_id for later
+                        // Update the $user_id for later.
                         $user_id       = $userdata->ID;
 
-                        // Two possible options
+                        // Two possible options.
                         $user_nicename = $userdata->user_nicename;
                         $user_login    = $userdata->user_login;
                 }
 
-                // Pull an audible and maybe use the login over the nicename
+                // Pull an audible and maybe use the login over the nicename.
                 $username = bp_is_username_compatibility_mode() ? $user_login : $user_nicename;
 
-        // Username found in cache so don't update it again
+        // Username found in cache so don't update it again.
         } else {
                 $update_cache = false;
         }
 
-        // Add this to cache
+        // Add this to cache.
         if ( ( true === $update_cache ) && !empty( $username ) ) {
                 wp_cache_set( 'bp_user_username_' . $user_id, $username, 'bp' );
 
         // @todo bust this cache if no $username found?
-        //} else {
-        //      wp_cache_delete( 'bp_user_username_' . $user_id );
+        // } else {
+        // wp_cache_delete( 'bp_user_username_' . $user_id );
         }
 
@@ -385 +379 @@
  *
  * @param int $user_id User ID to check.
- *
  * @return string|bool The username of the matched user, or false.
  */
@@ -394 +387 @@
                 $update_cache = true;
 
-                // User ID matches logged in user
+                // User ID matches logged in user.
                 if ( bp_loggedin_user_id() == $user_id ) {
                         $userdata = &$bp->loggedin_user->userdata;
 
-                // User ID matches displayed in user
+                // User ID matches displayed in user.
                 } elseif ( bp_displayed_user_id() == $user_id ) {
                         $userdata = &$bp->displayed_user->userdata;
 
-                // No user ID match
+                // No user ID match.
                 } else {
                         $userdata = false;
                 }
 
-                // No match so go dig
+                // No match so go dig.
                 if ( empty( $userdata ) ) {
 
-                        // User not found so return false
+                        // User not found so return false.
                         if ( !$userdata = bp_core_get_core_userdata( $user_id ) ) {
                                 return false;
@@ -416 +409 @@
                 }
 
-                // User nicename found
+                // User nicename found.
                 $user_nicename = $userdata->user_nicename;
 
-        // Nicename found in cache so don't update it again
+        // Nicename found in cache so don't update it again.
         } else {
                 $update_cache = false;
         }
 
-        // Add this to cache
+        // Add this to cache.
         if ( true == $update_cache && !empty( $user_nicename ) ) {
                 wp_cache_set( 'bp_members_user_nicename_' . $user_id, $user_nicename, 'bp' );
@@ -443 +436 @@
  *
  * @param int $uid User ID to check.
- *
  * @return string The email for the matched user. Empty string if no user
  *                matched the $uid.
@@ -451 +443 @@
         if ( !$email = wp_cache_get( 'bp_user_email_' . $uid, 'bp' ) ) {
 
-                // User exists
+                // User exists.
                 $ud = bp_core_get_core_userdata( $uid );
                 if ( ! empty( $ud ) ) {
                         $email = $ud->user_email;
 
-                // User was deleted
+                // User was deleted.
                 } else {
                         $email = '';
@@ -477 +469 @@
  * Return a HTML formatted link for a user with the user's full name as the link text.
  *
- * eg: <a href="http://andy.example.com/">Andy Peatling</a>
+ * Eg: <a href="http://andy.example.com/">Andy Peatling</a>
  *
  * Optional parameters will return just the name or just the URL.
@@ -486 +478 @@
  * @param bool $just_link Disable full name and HTML and just return the URL
  *                        text. Default false.
- *
  * @return string|bool The link text based on passed parameters, or false on
  *                     no match.
@@ -528 +519 @@
  * @since 2.0.0
  *
- * @param array $user_ids
- *
+ * @param array $user_ids Array of user IDs to get display names for.
  * @return array
  */
 function bp_core_get_user_displaynames( $user_ids ) {
 
-        // Sanitize
+        // Sanitize.
         $user_ids = wp_parse_id_list( $user_ids );
 
-        // Remove dupes and empties
+        // Remove dupes and empties.
         $user_ids = array_unique( array_filter( $user_ids ) );
 
@@ -551 +541 @@
         }
 
-        // Prime caches
+        // Prime caches.
         if ( ! empty( $uncached_ids ) ) {
                 if ( bp_is_active( 'xprofile' ) ) {
                         $fullname_data = BP_XProfile_ProfileData::get_value_byid( 1, $uncached_ids );
 
-                        // Key by user_id
+                        // Key by user_id.
                         $fullnames = array();
                         foreach ( $fullname_data as $fd ) {
@@ -565 +555 @@
 
                         // If xprofiledata is not found for any users,  we'll look
-                        // them up separately
+                        // them up separately.
                         $no_xprofile_ids = array_diff( $uncached_ids, array_keys( $fullnames ) );
                 } else {
@@ -573 +563 @@
 
                 if ( ! empty( $no_xprofile_ids ) ) {
-                        // Use WP_User_Query because we don't need BP information
+                        // Use WP_User_Query because we don't need BP information.
                         $query = new WP_User_Query( array(
                                 'include'     => $no_xprofile_ids,
@@ -585 +575 @@
 
                                 // If xprofile is active, set this value as the
-                                // xprofile display name as well
+                                // xprofile display name as well.
                                 if ( bp_is_active( 'xprofile' ) ) {
                                         xprofile_set_field_data( 1, $qr->ID, $fullnames[ $qr->ID ] );
@@ -609 +599 @@
  *
  * @param int|string|bool $user_id_or_username User ID or username.
- *
  * @return string|bool The display name for the user in question, or false if
  *                     user not found.
@@ -655 +644 @@
  *
  * @param string $email The email address for the user.
- *
  * @return string The link to the users home base. False on no match.
  */
@@ -677 +665 @@
  *                         this should be user_login, otherwise it should
  *                         be user_nicename.
- *
  * @return string|bool The link to the user's domain, false on no match.
  */
@@ -739 +726 @@
                 $bp = buddypress();
 
-                // Avoid a costly join by splitting the lookup
+                // Avoid a costly join by splitting the lookup.
                 if ( is_multisite() ) {
                         $sql = "SELECT ID FROM {$wpdb->users} WHERE (user_status != 0 OR deleted != 0 OR user_status != 0)";
@@ -781 +768 @@
  *                              performed this cleanup independently, as when hooked
  *                              to 'make_spam_user'.
- *
  * @return bool True on success, false on failure.
  */
@@ -787 +773 @@
         global $wpdb;
 
-        // Bail if no user ID
+        // Bail if no user ID.
         if ( empty( $user_id ) ) {
                 return;
         }
 
-        // Bail if user ID is super admin
+        // Bail if user ID is super admin.
         if ( is_super_admin( $user_id ) ) {
                 return;
         }
 
-        // Get the functions file
+        // Get the functions file.
         if ( is_multisite() ) {
                 require_once( ABSPATH . 'wp-admin/includes/ms.php' );
@@ -804 +790 @@
         $is_spam = ( 'spam' == $status );
 
-        // Only you can prevent infinite loops
+        // Only you can prevent infinite loops.
         remove_action( 'make_spam_user', 'bp_core_mark_user_spam_admin' );
         remove_action( 'make_ham_user',  'bp_core_mark_user_ham_admin'  );
 
-        // force the cleanup of WordPress content and status for multisite configs
+        // Force the cleanup of WordPress content and status for multisite configs.
         if ( $do_wp_cleanup ) {
 
-                // Get the blogs for the user
+                // Get the blogs for the user.
                 $blogs = get_blogs_of_user( $user_id, true );
 
                 foreach ( (array) array_values( $blogs ) as $details ) {
 
-                        // Do not mark the main or current root blog as spam
+                        // Do not mark the main or current root blog as spam.
                         if ( 1 == $details->userblog_id || bp_get_root_blog_id() == $details->userblog_id ) {
                                 continue;
                         }
 
-                        // Update the blog status
+                        // Update the blog status.
                         update_blog_status( $details->userblog_id, 'spam', $is_spam );
                 }
 
-                // Finally, mark this user as a spammer
+                // Finally, mark this user as a spammer.
                 if ( is_multisite() ) {
                         update_user_status( $user_id, 'spam', $is_spam );
@@ -831 +817 @@
         }
 
-        // Update the user status
+        // Update the user status.
         $wpdb->update( $wpdb->users, array( 'user_status' => $is_spam ), array( 'ID' => $user_id ) );
 
-        // Clean user cache
+        // Clean user cache.
         clean_user_cache( $user_id );
 
         if ( ! is_multisite() ) {
-                // Call multisite actions in single site mode for good measure
+                // Call multisite actions in single site mode for good measure.
                 if ( true === $is_spam ) {
 
@@ -862 +848 @@
         }
 
-        // Hide this user's activity
+        // Hide this user's activity.
         if ( ( true === $is_spam ) && bp_is_active( 'activity' ) ) {
                 bp_activity_hide_user_activity( $user_id );
         }
 
-        // We need a special hook for is_spam so that components can delete data at spam time
+        // We need a special hook for is_spam so that components can delete data at spam time.
         if ( true === $is_spam ) {
 
@@ -900 +886 @@
         do_action( 'bp_core_process_spammer_status', $user_id, $is_spam );
 
-        // Put things back how we found them
+        // Put things back how we found them.
         add_action( 'make_spam_user', 'bp_core_mark_user_spam_admin' );
         add_action( 'make_ham_user',  'bp_core_mark_user_ham_admin'  );
@@ -934 +920 @@
  *
  * @param int $user_id The ID for the user.
- *
  * @return bool True if spammer, otherwise false.
  */
 function bp_is_user_spammer( $user_id = 0 ) {
 
-        // No user to check
+        // No user to check.
         if ( empty( $user_id ) ) {
                 return false;
@@ -946 +931 @@
         $bp = buddypress();
 
-        // Assume user is not spam
+        // Assume user is not spam.
         $is_spammer = false;
 
-        // Setup our user
+        // Setup our user.
         $user = false;
 
-        // Get locally-cached data if available
+        // Get locally-cached data if available.
         switch ( $user_id ) {
                 case bp_loggedin_user_id() :
@@ -963 +948 @@
         }
 
-        // Manually get userdata if still empty
+        // Manually get userdata if still empty.
         if ( empty( $user ) ) {
                 $user = get_userdata( $user_id );
         }
 
-        // No user found
+        // No user found.
         if ( empty( $user ) ) {
                 $is_spammer = false;
 
-        // User found
+        // User found.
         } else {
 
-                // Check if spam
+                // Check if spam.
                 if ( !empty( $user->spam ) ) {
                         $is_spammer = true;
@@ -999 +984 @@
  *
  * @param int $user_id The ID for the user.
- *
  * @return bool True if deleted, otherwise false.
  */
 function bp_is_user_deleted( $user_id = 0 ) {
 
-        // No user to check
+        // No user to check.
         if ( empty( $user_id ) ) {
                 return false;
@@ -1011 +995 @@
         $bp = buddypress();
 
-        // Assume user is not deleted
+        // Assume user is not deleted.
         $is_deleted = false;
 
-        // Setup our user
+        // Setup our user.
         $user = false;
 
-        // Get locally-cached data if available
+        // Get locally-cached data if available.
         switch ( $user_id ) {
                 case bp_loggedin_user_id() :
@@ -1028 +1012 @@
         }
 
-        // Manually get userdata if still empty
+        // Manually get userdata if still empty.
         if ( empty( $user ) ) {
                 $user = get_userdata( $user_id );
         }
 
-        // No user found
+        // No user found.
         if ( empty( $user ) ) {
                 $is_deleted = true;
 
-        // User found
+        // User found.
         } else {
 
-                // Check if deleted
+                // Check if deleted.
                 if ( !empty( $user->deleted ) ) {
                         $is_deleted = true;
@@ -1071 +1055 @@
  *
  * @param int $user_id The user ID to check.
- *
  * @return bool True if active, otherwise false.
  */
 function bp_is_user_active( $user_id = 0 ) {
 
-        // Default to current user
+        // Default to current user.
         if ( empty( $user_id ) && is_user_logged_in() ) {
                 $user_id = bp_loggedin_user_id();
         }
 
-        // No user to check
+        // No user to check.
         if ( empty( $user_id ) ) {
                 return false;
         }
 
-        // Check spam
+        // Check spam.
         if ( bp_is_user_spammer( $user_id ) ) {
                 return false;
         }
 
-        // Check deleted
+        // Check deleted.
         if ( bp_is_user_deleted( $user_id ) ) {
                 return false;
         }
 
-        // Assume true if not spam or deleted
+        // Assume true if not spam or deleted.
         return true;
 }
@@ -1113 +1096 @@
  *
  * @param int $user_id The user ID to check.
- *
  * @return bool True if inactive, otherwise false.
  */
 function bp_is_user_inactive( $user_id = 0 ) {
 
-        // Default to current user
+        // Default to current user.
         if ( empty( $user_id ) && is_user_logged_in() ) {
                 $user_id = bp_loggedin_user_id();
         }
 
-        // No user to check
+        // No user to check.
         if ( empty( $user_id ) ) {
                 return false;
         }
 
-        // Return the inverse of active
+        // Return the inverse of active.
         return !bp_is_user_active( $user_id );
 }
@@ -1139 +1121 @@
  * @param int    $user_id ID of the user being updated.
  * @param string $time    Time of last activity, in 'Y-m-d H:i:s' format.
- *
  * @return bool True on success, false on failure.
  */
 function bp_update_user_last_activity( $user_id = 0, $time = '' ) {
 
-        // Fall back on current user
+        // Fall back on current user.
         if ( empty( $user_id ) ) {
                 $user_id = bp_loggedin_user_id();
         }
 
-        // Bail if the user id is 0, as there's nothing to update
+        // Bail if the user id is 0, as there's nothing to update.
         if ( empty( $user_id ) ) {
                 return false;
         }
 
-        // Fall back on current time
+        // Fall back on current time.
         if ( empty( $time ) ) {
                 $time = bp_core_current_time();
@@ -1183 +1164 @@
  * @access private For internal use only.
  *
- * @param null   $retval
+ * @param null   $retval Null retval value.
  * @param int    $object_id ID of the user.
  * @param string $meta_key  Meta key being fetched.
- *
  * @return mixed
  */
@@ -1193 +1173 @@
 
         if ( 'last_activity' === $meta_key ) {
-                // Don't send the warning more than once per pageload
+                // Don't send the warning more than once per pageload.
                 if ( false === $warned ) {
                         _doing_it_wrong( 'get_user_meta( $user_id, \'last_activity\' )', __( 'User last_activity data is no longer stored in usermeta. Use bp_get_user_last_activity() instead.', 'buddypress' ), '2.0.0' );
@@ -1235 +1215 @@
  *
  * @param int $user_id The ID of the user.
- *
  * @return string Time of last activity, in 'Y-m-d H:i:s' format, or an empty
  *                string if none is found.
@@ -1274 +1253 @@
         // Wipe out existing last_activity data in the activity table -
         // this helps to prevent duplicates when pulling from the usermeta
-        // table
+        // table.
         $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->members->table_name_last_activity} WHERE component = %s AND type = 'last_activity'", $bp->members->id ) );
 
@@ -1295 +1274 @@
  *
  * @param int $user_id ID of the user being queried.
- *
  * @return array Post IDs.
  */
@@ -1319 +1297 @@
 function bp_core_delete_account( $user_id = 0 ) {
 
-        // Use logged in user ID if none is passed
+        // Use logged in user ID if none is passed.
         if ( empty( $user_id ) ) {
                 $user_id = bp_loggedin_user_id();
         }
 
-        // Site admins cannot be deleted
+        // Site admins cannot be deleted.
         if ( is_super_admin( $user_id ) ) {
                 return false;
         }
 
-        // Extra checks if user is not deleting themselves
+        // Extra checks if user is not deleting themselves.
         if ( bp_loggedin_user_id() !== absint( $user_id ) ) {
 
-                // Bail if current user cannot delete any users
+                // Bail if current user cannot delete any users.
                 if ( ! bp_current_user_can( 'delete_users' ) ) {
                         return false;
                 }
 
-                // Bail if current user cannot delete this user
+                // Bail if current user cannot delete this user.
                 if ( ! current_user_can_for_blog( bp_get_root_blog_id(), 'delete_user', $user_id ) ) {
                         return false;
@@ -1352 +1330 @@
         do_action( 'bp_core_pre_delete_account', $user_id );
 
-        // Specifically handle multi-site environment
+        // Specifically handle multi-site environment.
         if ( is_multisite() ) {
                 require_once( ABSPATH . '/wp-admin/includes/ms.php'   );
@@ -1359 +1337 @@
                 $retval = wpmu_delete_user( $user_id );
 
-        // Single site user deletion
+        // Single site user deletion.
         } else {
                 require_once( ABSPATH . '/wp-admin/includes/user.php' );
@@ -1383 +1361 @@
  *
  * @param int $user_id ID of the user who is about to be deleted.
- *
  * @return bool True on success, false on failure.
  */
@@ -1401 +1378 @@
  *
  * @param string $str String to be upper-cased.
- *
  * @return string
  */
@@ -1423 +1399 @@
  * @param WP_User|WP_Error $user Either the WP_User object or the WP_Error
  *                               object, as passed to the 'authenticate' filter.
- *
  * @return WP_User|WP_Error If the user is not a spammer, return the WP_User
  *                          object. Otherwise a new WP_Error object.
@@ -1429 +1404 @@
 function bp_core_boot_spammer( $user ) {
 
-        // check to see if the $user has already failed logging in, if so return $user as-is
+        // Check to see if the $user has already failed logging in, if so return $user as-is.
         if ( is_wp_error( $user ) || empty( $user ) ) {
                 return $user;
         }
 
-        // the user exists; now do a check to see if the user is a spammer
+        // The user exists; now do a check to see if the user is a spammer
         // if the user is a spammer, stop them in their tracks!
         if ( is_a( $user, 'WP_User' ) && ( ( is_multisite() && (int) $user->spam ) || 1 == $user->user_status ) ) {
@@ -1440 +1415 @@
         }
 
-        // user is good to go!
+        // User is good to go!
         return $user;
 }
@@ -1452 +1427 @@
 function bp_core_remove_data( $user_id ) {
 
-        // Remove last_activity data
+        // Remove last_activity data.
         BP_Core_User::delete_last_activity( $user_id );
 
-        // Flush the cache to remove the user from all cached objects
+        // Flush the cache to remove the user from all cached objects.
         wp_cache_flush();
 }
@@ -1499 +1474 @@
  *                               Multisite settings.
  * @param array|string $oldvalue The old value of the option.
- *
  * @return array Merged and unique array of illegal names.
  */
 function bp_core_get_illegal_names( $value = '', $oldvalue = '' ) {
 
-        // Make sure $value is array
+        // Make sure $value is array.
         if ( empty( $value ) ) {
                 $db_illegal_names = array();
@@ -1531 +1505 @@
         );
 
-        // Core constants
+        // Core constants.
         $slug_constants = array(
                 'BP_GROUPS_SLUG',
@@ -1561 +1535 @@
         $filtered_illegal_names = apply_filters( 'bp_core_illegal_usernames', array_merge( array( 'www', 'web', 'root', 'admin', 'main', 'invite', 'administrator' ), $bp_component_slugs ) );
 
-        // Merge the arrays together
+        // Merge the arrays together.
         $merged_names           = array_merge( (array) $filtered_illegal_names, (array) $db_illegal_names );
 
-        // Remove duplicates
+        // Remove duplicates.
         $illegal_names          = array_unique( (array) $merged_names );
 
@@ -1590 +1564 @@
  *
  * @param string $user_email The email being checked.
- *
  * @return bool|array True if the address passes all checks; otherwise an array
  *                    of error codes.
@@ -1605 +1578 @@
 
         // Is the email on the Banned Email Domains list?
-        // Note: This check only works on Multisite
+        // Note: This check only works on Multisite.
         if ( function_exists( 'is_email_address_unsafe' ) && is_email_address_unsafe( $user_email ) ) {
                 $errors['domain_banned'] = 1;
@@ -1611 +1584 @@
 
         // Is the email on the Limited Email Domains list?
-        // Note: This check only works on Multisite
+        // Note: This check only works on Multisite.
         $limited_email_domains = get_site_option( 'limited_email_domains' );
         if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) {
@@ -1668 +1641 @@
  * @param string $user_name  Username to validate.
  * @param string $user_email Email address to validate.
- *
  * @return array Results of user validation including errors, if any.
  */
 function bp_core_validate_user_signup( $user_name, $user_email ) {
 
-        // Make sure illegal names include BuddyPress slugs and values
+        // Make sure illegal names include BuddyPress slugs and values.
         bp_core_flush_illegal_names();
 
@@ -1683 +1655 @@
         // When not running Multisite, we perform our own validation. What
         // follows reproduces much of the logic of wpmu_validate_user_signup(),
-        // minus the multisite-specific restrictions on user_login
+        // minus the multisite-specific restrictions on user_login.
         } else {
                 $errors = new WP_Error();
@@ -1696 +1668 @@
                 $user_name = apply_filters( 'pre_user_login', $user_name );
 
-                // User name can't be empty
+                // User name can't be empty.
                 if ( empty( $user_name ) ) {
                         $errors->add( 'user_name', __( 'Please enter a username', 'buddypress' ) );
                 }
 
-                // user name can't be on the blacklist
+                // User name can't be on the blacklist.
                 $illegal_names = get_site_option( 'illegal_names' );
                 if ( in_array( $user_name, (array) $illegal_names ) ) {
@@ -1707 +1679 @@
                 }
 
-                // User name must pass WP's validity check
+                // User name must pass WP's validity check.
                 if ( ! validate_username( $user_name ) ) {
                         $errors->add( 'user_name', __( 'Usernames can contain only letters, numbers, ., -, and @', 'buddypress' ) );
                 }
 
-                // Minimum of 4 characters
+                // Minimum of 4 characters.
                 if ( strlen( $user_name ) < 4 ) {
                         $errors->add( 'user_name',  __( 'Username must be at least 4 characters', 'buddypress' ) );
@@ -1729 +1701 @@
                 }
 
-                // Check into signups
+                // Check into signups.
                 $signups = BP_Signup::get( array(
                         'user_login' => $user_name,
@@ -1742 +1714 @@
 
                 // Validate the email address and process the validation results into
-                // error messages
+                // error messages.
                 $validate_email = bp_core_validate_email_address( $user_email );
                 bp_core_add_validation_error_messages( $errors, $validate_email );
 
-                // Assemble the return array
+                // Assemble the return array.
                 $result = array(
                         'user_name'  => $user_name,
@@ -1753 +1725 @@
                 );
 
-                // Apply WPMU legacy filter
+                // Apply WPMU legacy filter.
                 $result = apply_filters( 'wpmu_validate_user_signup', $result );
         }
@@ -1774 +1746 @@
  * @param string $blog_url   Blog URL requested during registration.
  * @param string $blog_title Blog title requested during registration.
- *
  * @return array
  */
@@ -1802 +1773 @@
  * @param array  $usermeta      Miscellaneous metadata about the user (blog-specific
  *                              signup data, xprofile data, etc).
- *
  * @return bool|WP_Error True on success, WP_Error on failure.
  */
@@ -1808 +1778 @@
         $bp = buddypress();
 
-        // We need to cast $user_id to pass to the filters
+        // We need to cast $user_id to pass to the filters.
         $user_id = false;
 
-        // Multisite installs have their own install procedure
+        // Multisite installs have their own install procedure.
         if ( is_multisite() ) {
                 wpmu_signup_user( $user_login, $user_email, $usermeta );
 
         } else {
-                // Format data
+                // Format data.
                 $user_login     = preg_replace( '/\s+/', '', sanitize_user( $user_login, true ) );
                 $user_email     = sanitize_email( $user_email );
@@ -1899 +1869 @@
  * @param string $user_email  Email address of requesting user.
  * @param string $usermeta    Miscellaneous metadata for the user.
- *
  * @return bool
  */
@@ -1908 +1877 @@
 
         /**
-         * Filters the result of wpmu_signup_blog()
+         * Filters the result of wpmu_signup_blog().
          *
          * This filter provides no value and is retained for
@@ -1924 +1893 @@
  *
  * @param string $key Activation key.
- *
  * @return int|bool User ID on success, false on failure.
  */
@@ -1932 +1900 @@
         $user = false;
 
-        // Multisite installs have their own activation routine
+        // Multisite installs have their own activation routine.
         if ( is_multisite() ) {
                 $user = wpmu_activate_signup( $key );
 
-                // If there were errors, add a message and redirect
+                // If there were errors, add a message and redirect.
                 if ( ! empty( $user->errors ) ) {
                         return $user;
@@ -1962 +1930 @@
                 }
 
-                // password is hashed again in wp_insert_user
+                // Password is hashed again in wp_insert_user.
                 $password = wp_generate_password( 12, false );
 
                 $user_id = username_exists( $signup->user_login );
 
-                // Create the user
+                // Create the user.
                 if ( ! $user_id ) {
                         $user_id = wp_create_user( $signup->user_login, $password, $signup->user_email );
@@ -1974 +1942 @@
                 // created locally for backward compatibility. Process it.
                 } elseif ( $key == wp_hash( $user_id ) ) {
-                        // Change the user's status so they become active
+                        // Change the user's status so they become active.
                         if ( ! $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->users} SET user_status = 0 WHERE ID = %d", $user_id ) ) ) {
                                 return new WP_Error( 'invalid_key', __( 'Invalid activation key.', 'buddypress' ) );
@@ -1994 +1962 @@
                 }
 
-                // Fetch the signup so we have the data later on
+                // Fetch the signup so we have the data later on.
                 $signups = BP_Signup::get( array(
                         'activation_key' => $key,
@@ -2001 +1969 @@
                 $signup = isset( $signups['signups'] ) && ! empty( $signups['signups'][0] ) ? $signups['signups'][0] : false;
 
-                // Activate the signup
+                // Activate the signup.
                 BP_Signup::validate( $key );
 
@@ -2008 +1976 @@
                 }
 
-                // Set up data to pass to the legacy filter
+                // Set up data to pass to the legacy filter.
                 $user = array(
                         'user_id'  => $user_id,
@@ -2015 +1983 @@
                 );
 
-                // Notify the site admin of a new user registration
+                // Notify the site admin of a new user registration.
                 wp_new_user_notification( $user_id );
 
@@ -2034 +2002 @@
         }
 
-        // Set any profile data
+        // Set any profile data.
         if ( bp_is_active( 'xprofile' ) ) {
                 if ( ! empty( $user['meta']['profile_field_ids'] ) ) {
@@ -2046 +2014 @@
                                 }
 
-                                // Save the visibility level
+                                // Save the visibility level.
                                 $visibility_level = ! empty( $user['meta']['field_' . $field_id . '_visibility'] ) ? $user['meta']['field_' . $field_id . '_visibility'] : 'public';
                                 xprofile_set_field_visibility_level( $field_id, $user_id, $visibility_level );
@@ -2053 +2021 @@
         }
 
-        // Update the display_name
+        // Update the display_name.
         wp_update_user( array(
                 'ID'           => $user_id,
@@ -2059 +2027 @@
         ) );
 
-        // Set the password on multisite installs
+        // Set the password on multisite installs.
         if ( ! empty( $user['meta']['password'] ) ) {
                 $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->users} SET user_pass = %s WHERE ID = %d", $user['meta']['password'], $user_id ) );
@@ -2102 +2070 @@
 
                 // Fetch activation keys separately, to avoid the all_with_meta
-                // overhead
+                // overhead.
                 $status_2_ids_sql = implode( ',', $status_2_ids );
                 $ak_data = $wpdb->get_results( "SELECT user_id, meta_value FROM {$wpdb->usermeta} WHERE meta_key = 'activation_key' AND user_id IN ({$status_2_ids_sql})" );
 
-                // Rekey
+                // Rekey.
                 $activation_keys = array();
                 foreach ( $ak_data as $ak_datum ) {
@@ -2114 +2082 @@
                 unset( $status_2_ids_sql, $status_2_ids, $ak_data );
 
-                // Merge
+                // Merge.
                 foreach ( $signups as &$signup ) {
                         if ( isset( $activation_keys[ $signup->ID ] ) ) {
@@ -2121 +2089 @@
                 }
 
-                // Reset the signup var as we're using it to process the migration
+                // Reset the signup var as we're using it to process the migration.
                 unset( $signup );
 
@@ -2131 +2099 @@
                 $meta = array();
 
-                // Rebuild the activation key, if missing
+                // Rebuild the activation key, if missing.
                 if ( empty( $signup->activation_key ) ) {
                         $signup->activation_key = wp_hash( $signup->ID );
@@ -2153 +2121 @@
                 ) );
 
-                // Deleting these options will remove signups from users count
+                // Deleting these options will remove signups from users count.
                 delete_user_option( $signup->ID, 'capabilities' );
                 delete_user_option( $signup->ID, 'user_level'   );
@@ -2166 +2134 @@
  *
  * @param int $user_id ID of the user.
- *
  * @return bool
  */
@@ -2176 +2143 @@
         }
 
-        // Add the user's fullname to Xprofile
+        // Add the user's fullname to Xprofile.
         if ( bp_is_active( 'xprofile' ) ) {
                 $firstname = bp_get_user_meta( $user_id, 'first_name', true );
@@ -2296 +2263 @@
  * @param string           $username The inputted, attempted username.
  * @param string           $password The inputted, attempted password.
- *
  * @return WP_User|WP_Error
  */
 function bp_core_signup_disable_inactive( $user = null, $username = '', $password ='' ) {
-        // login form not used
+        // Login form not used.
         if ( empty( $username ) && empty( $password ) ) {
                 return $user;
@@ -2312 +2278 @@
 
         // If no WP_User is found corresponding to the username, this
-        // is a potential signup
+        // is a potential signup.
         } elseif ( is_wp_error( $user ) && 'invalid_username' == $user->get_error_code() ) {
                 $user_login = $username;
 
-        // This is an activated user, so bail
+        // This is an activated user, so bail.
         } else {
                 return $user;
         }
 
-        // Look for the unactivated signup corresponding to the login name
+        // Look for the unactivated signup corresponding to the login name.
         $signup = BP_Signup::get( array( 'user_login' => sanitize_user( $user_login ) ) );
 
@@ -2330 +2296 @@
 
         // Unactivated user account found!
-        // Set up the feedback message
+        // Set up the feedback message.
         $signup_id = $signup['signups'][0]->signup_id;
 
@@ -2363 +2329 @@
         }
 
-        // verify nonce
+        // Verify nonce.
         if ( ! wp_verify_nonce( $_GET['_wpnonce'], 'bp-resend-activation' ) ) {
                 die( 'Security check' );
@@ -2370 +2336 @@
         $signup_id = (int) $_GET['id'];
 
-        // resend the activation email
-        // also updates the 'last sent' and '# of emails sent' values
+        // Resend the activation email.
+        // also updates the 'last sent' and '# of emails sent' values.
         $resend = BP_Signup::resend( array( $signup_id ) );
 
-        // add feedback message
+        // Add feedback message.
         if ( ! empty( $resend['errors'] ) ) {
                 $error = __( '<strong>ERROR</strong>: Your account has already been activated.', 'buddypress' );
@@ -2388 +2354 @@
 function bp_core_wpsignup_redirect() {
 
-        // Bail in admin or if custom signup page is broken
+        // Bail in admin or if custom signup page is broken.
         if ( is_admin() || ! bp_has_custom_signup_page() ) {
                 return;
@@ -2395 +2361 @@
         $action = !empty( $_GET['action'] ) ? $_GET['action'] : '';
 
-        // Not at the WP core signup page and action is not register
+        // Not at the WP core signup page and action is not register.
         if ( ! empty( $_SERVER['SCRIPT_NAME'] ) && false === strpos( $_SERVER['SCRIPT_NAME'], 'wp-signup.php' ) && ( 'register' != $action ) ) {
                 return;
@@ -2426 +2392 @@
  */
 function bp_stop_live_spammer() {
-        // if we're on the login page, stop now to prevent redirect loop
+        // If we're on the login page, stop now to prevent redirect loop.
         $is_login = false;
         if ( isset( $GLOBALS['pagenow'] ) && ( false !== strpos( $GLOBALS['pagenow'], 'wp-login.php' ) ) ) {
@@ -2438 +2404 @@
         }
 
-        // user isn't logged in, so stop!
+        // User isn't logged in, so stop!
         if ( ! is_user_logged_in() ) {
                 return;
         }
 
-        // if spammer, redirect to wp-login.php and reauthorize
+        // If spammer, redirect to wp-login.php and reauthorize.
         if ( bp_is_user_spammer( bp_loggedin_user_id() ) ) {
-                // setup login args
+                // Setup login args.
                 $args = array(
-                        // custom action used to throw an error message
+                        // Custom action used to throw an error message.
                         'action' => 'bp-spam',
 
-                        // reauthorize user to login
+                        // Reauthorize user to login.
                         'reauth' => 1
                 );
@@ -2463 +2429 @@
                 $login_url = apply_filters( 'bp_live_spammer_redirect', add_query_arg( $args, wp_login_url() ) );
 
-                // redirect user to login page
+                // Redirect user to login page.
                 wp_redirect( $login_url );
                 die();
@@ -2480 +2446 @@
         $error = __( '<strong>ERROR</strong>: Your account has been marked as a spammer.', 'buddypress' );
 
-        // shake shake shake!
+        // Shake shake shake!
         add_action( 'login_head', 'wp_shake_js', 12 );
 }
@@ -2587 +2553 @@
  *
  * @param string $member_type The name of the member type.
- *
  * @return object A member type object.
  */
@@ -2614 +2579 @@
  *                               element from the array needs to match; 'and' means all elements
  *                               must match. Accepts 'or' or 'and'. Default 'and'.
- *
  * @return array A list of member type names or objects.
  */
@@ -2652 +2616 @@
  * @param bool   $append      Optional. True to append this to existing types for user,
  *                            false to replace. Default: false.
- * @return See {@see bp_set_object_terms()}.
+ * @return array $retval See {@see bp_set_object_terms()}.
  */
 function bp_set_member_type( $user_id, $member_type, $append = false ) {
@@ -2688 +2652 @@
  * @param int    $user_id     ID of the user.
  * @param string $member_type Member Type.
- *
  * @return bool|WP_Error
  */
@@ -2722 +2685 @@
  * @since 2.2.0
  *
- * @param int               $user_id ID of the user.
- * @param bool              $single  Optional. Whether to return a single type string. If multiple types are found
- *                                   for the user, the oldest one will be returned. Default: true.
- *
+ * @param int  $user_id ID of the user.
+ * @param bool $single  Optional. Whether to return a single type string. If multiple types are found
+ *                      for the user, the oldest one will be returned. Default: true.
  * @return string|array|bool On success, returns a single member type (if $single is true) or an array of member
  *                           types (if $single is false). Returns false on failure.
@@ -2769 +2731 @@
  * @param int    $user_id     $user_id ID of the user.
  * @param string $member_type Member Type.
- *
  * @return bool Whether the user has the given member type.
  */
@@ -2794 +2755 @@
  *
  * @param int $user_id ID of the user.
- *
- * @return See {@see bp_set_member_type()}.
+ * @return array $value See {@see bp_set_member_type()}.
  */
 function bp_remove_member_type_on_user_delete( $user_id ) {

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',

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

@@ -69 +69 @@
                 return;
 
-        // Not a directory
+        // Not a directory.
         bp_update_is_directory( false, 'register' );
 
-        // If the user is logged in, redirect away from here
+        // If the user is logged in, redirect away from here.
         if ( is_user_logged_in() ) {
 
@@ -96 +96 @@
                 $bp->signup->step = 'registration-disabled';
 
-        // If the signup page is submitted, validate and save
+        // If the signup page is submitted, validate and save.
         } elseif ( isset( $_POST['signup_submit'] ) && bp_verify_nonce_request( 'bp_new_signup' ) ) {
 
@@ -106 +106 @@
                 do_action( 'bp_signup_pre_validate' );
 
-                // Check the base account details for problems
+                // Check the base account details for problems.
                 $account_details = bp_core_validate_user_signup( $_POST['signup_username'], $_POST['signup_email'] );
 
-                // If there are errors with account details, set them for display
+                // If there are errors with account details, set them for display.
                 if ( !empty( $account_details['errors']->errors['user_name'] ) )
                         $bp->signup->errors['signup_username'] = $account_details['errors']->errors['user_name'][0];
@@ -116 +116 @@
                         $bp->signup->errors['signup_email'] = $account_details['errors']->errors['user_email'][0];
 
-                // Check that both password fields are filled in
+                // Check that both password fields are filled in.
                 if ( empty( $_POST['signup_password'] ) || empty( $_POST['signup_password_confirm'] ) )
                         $bp->signup->errors['signup_password'] = __( 'Please make sure you enter your password twice', 'buddypress' );
 
-                // Check that the passwords match
+                // Check that the passwords match.
                 if ( ( !empty( $_POST['signup_password'] ) && !empty( $_POST['signup_password_confirm'] ) ) && $_POST['signup_password'] != $_POST['signup_password_confirm'] )
                         $bp->signup->errors['signup_password'] = __( 'The passwords you entered do not match.', 'buddypress' );
@@ -127 +127 @@
                 $bp->signup->email = $_POST['signup_email'];
 
-                // Now we've checked account details, we can check profile information
+                // Now we've checked account details, we can check profile information.
                 if ( bp_is_active( 'xprofile' ) ) {
 
-                        // Make sure hidden field is passed and populated
+                        // Make sure hidden field is passed and populated.
                         if ( isset( $_POST['signup_profile_field_ids'] ) && !empty( $_POST['signup_profile_field_ids'] ) ) {
 
-                                // Let's compact any profile field info into an array
+                                // Let's compact any profile field info into an array.
                                 $profile_field_ids = explode( ',', $_POST['signup_profile_field_ids'] );
 
-                                // Loop through the posted fields formatting any datebox values then validate the field
+                                // Loop through the posted fields formatting any datebox values then validate the field.
                                 foreach ( (array) $profile_field_ids as $field_id ) {
                                         if ( !isset( $_POST['field_' . $field_id] ) ) {
@@ -143 +143 @@
                                         }
 
-                                        // Create errors for required fields without values
+                                        // Create errors for required fields without values.
                                         if ( xprofile_check_is_required_field( $field_id ) && empty( $_POST[ 'field_' . $field_id ] ) && ! bp_current_user_can( 'bp_moderate' ) )
                                                 $bp->signup->errors['field_' . $field_id] = __( 'This is a required field', 'buddypress' );
                                 }
 
-                        // This situation doesn't naturally occur so bounce to website root
+                        // This situation doesn't naturally occur so bounce to website root.
                         } else {
                                 bp_core_redirect( bp_get_root_domain() );
@@ -154 +154 @@
                 }
 
-                // Finally, let's check the blog details, if the user wants a blog and blog creation is enabled
+                // Finally, let's check the blog details, if the user wants a blog and blog creation is enabled.
                 if ( isset( $_POST['signup_with_blog'] ) ) {
                         $active_signup = bp_core_get_root_option( 'registration' );
@@ -161 +161 @@
                                 $blog_details = bp_core_validate_blog_signup( $_POST['signup_blog_url'], $_POST['signup_blog_title'] );
 
-                                // If there are errors with blog details, set them for display
+                                // If there are errors with blog details, set them for display.
                                 if ( !empty( $blog_details['errors']->errors['blogname'] ) )
                                         $bp->signup->errors['signup_blog_url'] = $blog_details['errors']->errors['blogname'][0];
@@ -180 +180 @@
                 if ( !empty( $bp->signup->errors ) ) {
                         foreach ( (array) $bp->signup->errors as $fieldname => $error_message ) {
-                                // addslashes() and stripslashes() to avoid create_function()
-                                // syntax errors when the $error_message contains quotes
+                                /*
+                                 * The addslashes() and stripslashes() used to avoid create_function()
+                                 * syntax errors when the $error_message contains quotes.
+                                 */
 
                                 /**
@@ -200 +202 @@
                         if ( 'none' != $active_signup ) {
 
-                                // Make sure the extended profiles module is enabled
+                                // Make sure the extended profiles module is enabled.
                                 if ( bp_is_active( 'xprofile' ) ) {
-                                        // Let's compact any profile field info into usermeta
+                                        // Let's compact any profile field info into usermeta.
                                         $profile_field_ids = explode( ',', $_POST['signup_profile_field_ids'] );
 
-                                        // Loop through the posted fields formatting any datebox values then add to usermeta - @todo This logic should be shared with the same in xprofile_screen_edit_profile()
+                                        // Loop through the posted fields formatting any datebox values then add to usermeta - @todo This logic should be shared with the same in xprofile_screen_edit_profile().
                                         foreach ( (array) $profile_field_ids as $field_id ) {
                                                 if ( ! isset( $_POST['field_' . $field_id] ) ) {
 
                                                         if ( ! empty( $_POST['field_' . $field_id . '_day'] ) && ! empty( $_POST['field_' . $field_id . '_month'] ) && ! empty( $_POST['field_' . $field_id . '_year'] ) ) {
-                                                                // Concatenate the values
+                                                                // Concatenate the values.
                                                                 $date_value = $_POST['field_' . $field_id . '_day'] . ' ' . $_POST['field_' . $field_id . '_month'] . ' ' . $_POST['field_' . $field_id . '_year'];
 
-                                                                // Turn the concatenated value into a timestamp
+                                                                // Turn the concatenated value into a timestamp.
                                                                 $_POST['field_' . $field_id] = date( 'Y-m-d H:i:s', strtotime( $date_value ) );
                                                         }
@@ -225 +227 @@
                                         }
 
-                                        // Store the profile field ID's in usermeta
+                                        // Store the profile field ID's in usermeta.
                                         $usermeta['profile_field_ids'] = $_POST['signup_profile_field_ids'];
                                 }
 
-                                // Hash and store the password
+                                // Hash and store the password.
                                 $usermeta['password'] = wp_hash_password( $_POST['signup_password'] );
 
-                                // If the user decided to create a blog, save those details to usermeta
+                                // If the user decided to create a blog, save those details to usermeta.
                                 if ( 'blog' == $active_signup || 'all' == $active_signup )
                                         $usermeta['public'] = ( isset( $_POST['signup_blog_privacy'] ) && 'public' == $_POST['signup_blog_privacy'] ) ? true : false;
@@ -245 +247 @@
                                 $usermeta = apply_filters( 'bp_signup_usermeta', $usermeta );
 
-                                // Finally, sign up the user and/or blog
+                                // Finally, sign up the user and/or blog.
                                 if ( isset( $_POST['signup_with_blog'] ) && is_multisite() )
                                         $wp_user_id = bp_core_signup_blog( $blog_details['domain'], $blog_details['path'], $blog_details['blog_title'], $_POST['signup_username'], $_POST['signup_email'], $usermeta );
@@ -294 +296 @@
 function bp_core_screen_activation() {
 
-        // Bail if not viewing the activation page
+        // Bail if not viewing the activation page.
         if ( ! bp_is_current_component( 'activate' ) ) {
                 return false;
         }
 
-        // If the user is already logged in, redirect away from here
+        // If the user is already logged in, redirect away from here.
         if ( is_user_logged_in() ) {
 
@@ -308 +310 @@
                         : bp_get_root_domain();
 
-                // Trailing slash it, as we expect these URL's to be
+                // Trailing slash it, as we expect these URL's to be.
                 $redirect_to = trailingslashit( $redirect_to );
 
@@ -320 +322 @@
                 $redirect_to = apply_filters( 'bp_loggedin_activate_page_redirect_to', $redirect_to );
 
-                // Redirect away from the activation page
+                // Redirect away from the activation page.
                 bp_core_redirect( $redirect_to );
         }
 
-        // grab the key (the old way)
+        // Grab the key (the old way).
         $key = isset( $_GET['key'] ) ? $_GET['key'] : '';
 
-        // grab the key (the new way)
+        // Grab the key (the new way).
         if ( empty( $key ) ) {
                 $key = bp_current_action();
         }
 
-        // Get BuddyPress
+        // Get BuddyPress.
         $bp = buddypress();
 
-        // we've got a key; let's attempt to activate the signup
+        // We've got a key; let's attempt to activate the signup.
         if ( ! empty( $key ) ) {
 
@@ -348 +350 @@
                 $user = apply_filters( 'bp_core_activate_account', bp_core_activate_signup( $key ) );
 
-                // If there were errors, add a message and redirect
+                // If there were errors, add a message and redirect.
                 if ( ! empty( $user->errors ) ) {
                         bp_core_add_message( $user->get_error_message(), 'error' );
@@ -357 +359 @@
 
                 // Check if the signup avatar folder exists. If it does, move the folder to
-                // the BP user avatars directory
+                // the BP user avatars directory.
                 if ( file_exists( bp_core_avatar_upload_path() . '/avatars/signups/' . $hashed_key ) ) {
                         @rename( bp_core_avatar_upload_path() . '/avatars/signups/' . $hashed_key, bp_core_avatar_upload_path() . '/avatars/' . $user );
@@ -405 +407 @@
         public function is_members() {
 
-                // Bail if not looking at the members component or a user's page
+                // Bail if not looking at the members component or a user's page.
                 if ( ! bp_is_members_component() && ! bp_is_user() ) {
                         return;
                 }
 
-                // Members Directory
+                // Members Directory.
                 if ( ! bp_current_action() && ! bp_current_item() ) {
                         bp_update_is_directory( true, 'members' );
@@ -425 +427 @@
                         add_filter( 'bp_replace_the_content',                    array( $this, 'directory_content'    ) );
 
-                // User page
+                // User page.
                 } elseif ( bp_is_user() ) {
 
@@ -459 +461 @@
          *
          * @param array $templates The templates from bp_get_theme_compat_templates().
-         *
          * @return array $templates Array of custom templates to look for.
          */
         public function directory_template_hierarchy( $templates = array() ) {
 
-                // Set up the template hierarchy
+                // Set up the template hierarchy.
                 $new_templates = array();
                 if ( '' !== bp_get_current_member_type() ) {
@@ -481 +482 @@
 
                 // Merge new templates with existing stack
-                // @see bp_get_theme_compat_templates()
+                // @see bp_get_theme_compat_templates().
                 $templates = array_merge( (array) $new_templates, $templates );
 
@@ -527 +528 @@
          * @param string $templates The templates from
          *                          bp_get_theme_compat_templates().
-         *
          * @return array $templates Array of custom templates to look for.
          */
         public function single_template_hierarchy( $templates ) {
-                // Setup some variables we're going to reference in our custom templates
+                // Setup some variables we're going to reference in our custom templates.
                 $user_nicename = buddypress()->displayed_user->userdata->user_nicename;
 
@@ -550 +550 @@
 
                 // Merge new templates with existing stack
-                // @see bp_get_theme_compat_templates()
+                // @see bp_get_theme_compat_templates().
                 $templates = array_merge( (array) $new_templates, $templates );
 
@@ -612 +612 @@
         public function is_registration() {
 
-                // Bail if not looking at the registration or activation page
+                // Bail if not looking at the registration or activation page.
                 if ( ! bp_is_register_page() && ! bp_is_activation_page() ) {
                         return;
                 }
 
-                // Not a directory
+                // Not a directory.
                 bp_update_is_directory( false, 'register' );
 
-                // Setup actions
+                // Setup actions.
                 add_filter( 'bp_get_buddypress_template',                array( $this, 'template_hierarchy' ) );
                 add_action( 'bp_template_include_reset_dummy_post_data', array( $this, 'dummy_post'    ) );
@@ -637 +637 @@
          *
          * @param string $templates The templates from bp_get_theme_compat_templates().
-         *
          * @return array $templates Array of custom templates to look for.
          */
@@ -658 +657 @@
 
                 // Merge new templates with existing stack
-                // @see bp_get_theme_compat_templates()
+                // @see bp_get_theme_compat_templates().
                 $templates = array_merge( (array) $new_templates, $templates );
 
@@ -670 +669 @@
          */
         public function dummy_post() {
-                // Registration page
+                // Registration page.
                 if ( bp_is_register_page() ) {
                         $title = __( 'Create an Account', 'buddypress' );
@@ -678 +677 @@
                         }
 
-                // Activation page
+                // Activation page.
                 } else {
                         $title = __( 'Activate Your Account', 'buddypress' );

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

@@ -433 +433 @@
                          */
                         do_action('member_loop_end');
-                        // Do some cleaning up after the loop
+                        // Do some cleaning up after the loop.
                         $this->rewind_members();
                 }
@@ -455 +455 @@
                 $this->member      = $this->next_member();
 
-                // loop has just started
+                // Loop has just started.
                 if ( 0 == $this->current_member ) {
 
@@ -535 +535 @@
         global $members_template;
 
-        // Default user ID
+        // Default user ID.
         $user_id = 0;
 
-        // User filtering
+        // User filtering.
         if ( bp_is_user_friends() && ! bp_is_user_friend_requests() ) {
                 $user_id = bp_displayed_user_id();
@@ -559 +559 @@
         }
 
-        // type: active ( default ) | random | newest | popular | online | alphabetical
+        // Type: active ( default ) | random | newest | popular | online | alphabetical.
         $r = bp_parse_args( $args, array(
                 'type'                => 'active',
@@ -566 +566 @@
                 'max'                 => false,
 
-                'page_arg'            => 'upage',  // See https://buddypress.trac.wordpress.org/ticket/3679
-
-                'include'             => false,    // Pass a user_id or a list (comma-separated or array) of user_ids to only show these users
-                'exclude'             => false,    // Pass a user_id or a list (comma-separated or array) of user_ids to exclude these users
-
-                'user_id'             => $user_id, // Pass a user_id to only show friends of this user
+                'page_arg'            => 'upage',  // See https://buddypress.trac.wordpress.org/ticket/3679.
+
+                'include'             => false,    // Pass a user_id or a list (comma-separated or array) of user_ids to only show these users.
+                'exclude'             => false,    // Pass a user_id or a list (comma-separated or array) of user_ids to exclude these users.
+
+                'user_id'             => $user_id, // Pass a user_id to only show friends of this user.
                 'member_type'         => $member_type,
                 'member_type__in'     => '',
@@ -577 +577 @@
                 'search_terms'        => $search_terms_default,
 
-                'meta_key'            => false,    // Only return users with this usermeta
-                'meta_value'          => false,    // Only return users where the usermeta value matches. Requires meta_key
+                'meta_key'            => false,    // Only return users with this usermeta.
+                'meta_value'          => false,    // Only return users where the usermeta value matches. Requires meta_key.
 
                 'populate_extras'     => true      // Fetch usermeta? Friend count, last active etc.
@@ -592 +592 @@
         }
 
-        // Set per_page to max if max is larger than per_page
+        // Set per_page to max if max is larger than per_page.
         if ( !empty( $r['max'] ) && ( $r['per_page'] > $r['max'] ) ) {
                 $r['per_page'] = $r['max'];
         }
 
-        // Query for members and populate $members_template global
+        // Query for members and populate $members_template global.
         $members_template = new BP_Core_Members_Template(
                 $r['type'],
@@ -761 +761 @@
  * @since 1.7.0
  *
- * @param array $classes Array of custom classes
+ * @param array $classes Array of custom classes.
  */
 function bp_member_class( $classes = array() ) {
@@ -771 +771 @@
          * @since 1.7.0
          *
-         * @param array $classes Array of custom classes
+         * @param array $classes Array of custom classes.
          *
          * @return string Row class of the member
@@ -778 +778 @@
                 global $members_template;
 
-                // Add even/odd classes, but only if there's more than 1 member
+                // Add even/odd classes, but only if there's more than 1 member.
                 if ( $members_template->member_count > 1 ) {
                         $pos_in_loop = (int) $members_template->current_member;
                         $classes[]   = ( $pos_in_loop % 2 ) ? 'even' : 'odd';
 
-                // If we've only one member in the loop, don't bother with odd and even
+                // If we've only one member in the loop, don't bother with odd and even.
                 } else {
                         $classes[] = 'bp-single-member';
                 }
 
-                // Maybe add 'is-online' class
+                // Maybe add 'is-online' class.
                 if ( ! empty( $members_template->member->last_activity ) ) {
 
-                        // Calculate some times
+                        // Calculate some times.
                         $current_time  = strtotime( bp_core_current_time() );
                         $last_activity = strtotime( $members_template->member->last_activity );
@@ -802 +802 @@
                 }
 
-                // Add current user class
+                // Add current user class.
                 if ( bp_loggedin_user_id() === (int) $members_template->member->id ) {
                         $classes[] = 'is-current-user';
@@ -925 +925 @@
          * @since 1.2.0
          *
-         * @param string $value Formatted HTML <img> element,
-         *                      or raw avatar URL based on $html arg.
+         * @param string $value Formatted HTML <img> element, or raw avatar URL based on $html arg.
          */
         echo apply_filters( 'bp_member_avatar', bp_get_member_avatar( $args ) );
@@ -972 +971 @@
                  * @since 1.2.0
                  *
-                 * @param string $value Formatted HTML <img> element,
-                 *                      or raw avatar URL based on $html arg.
+                 * @param string $value Formatted HTML <img> element, or raw avatar URL based on $html arg.
                  */
                 return apply_filters( 'bp_get_member_avatar', bp_core_fetch_avatar( array( 'item_id' => $members_template->member->id, 'type' => $type, 'alt' => $alt, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'email' => $members_template->member->user_email ) ) );
@@ -1039 +1037 @@
                 global $members_template;
 
-                // Generally, this only fires when xprofile is disabled
+                // Generally, this only fires when xprofile is disabled.
                 if ( empty( $members_template->member->fullname ) ) {
-                        // Our order of preference for alternative fullnames
+                        // Our order of preference for alternative fullnames.
                         $name_stack = array(
                                 'display_name',
@@ -1050 +1048 @@
                         foreach ( $name_stack as $source ) {
                                 if ( !empty( $members_template->member->{$source} ) ) {
-                                        // When a value is found, set it as fullname and be done
-                                        // with it
+                                        // When a value is found, set it as fullname and be done with it.
                                         $members_template->member->fullname = $members_template->member->{$source};
                                         break;
@@ -1095 +1092 @@
                 global $members_template;
 
-                // Parse the activity format
+                // Parse the activity format.
                 $r = bp_parse_args( $args, array(
                         'active_format' => true
                 ) );
 
-                // Backwards compatibility for anyone forcing a 'true' active_format
+                // Backwards compatibility for anyone forcing a 'true' active_format.
                 if ( true === $r['active_format'] ) {
                         $r['active_format'] = __( 'active %s', 'buddypress' );
                 }
 
-                // Member has logged in at least one time
+                // Member has logged in at least one time.
                 if ( isset( $members_template->member->last_activity ) ) {
 
-                        // Backwards compatibility for pre 1.5 'ago' strings
+                        // Backwards compatibility for pre 1.5 'ago' strings.
                         $last_activity = ! empty( $r['active_format'] )
                                 ? bp_core_get_last_activity( $members_template->member->last_activity, $r['active_format'] )
                                 : bp_core_time_since( $members_template->member->last_activity );
 
-                // Member has never logged in or been active
+                // Member has never logged in or been active.
                 } else {
                         $last_activity = __( 'Never active', 'buddypress' );
@@ -1132 +1129 @@
  * Output the latest update of the current member in the loop.
  *
- * @param array|string $args
+ * @param array|string $args Array of arguments for latest update.
  */
 function bp_member_latest_update( $args = '' ) {
@@ -1224 +1221 @@
                 }
 
-                // Declare local variables
+                // Declare local variables.
                 $data = false;
 
-                // Guess at default $user_id
+                // Guess at default $user_id.
                 $default_user_id = 0;
                 if ( ! empty( $members_template->member->id ) ) {
@@ -1242 +1239 @@
                 $r = wp_parse_args( $args, $defaults );
 
-                // If we're in a members loop, get the data from the global
+                // If we're in a members loop, get the data from the global.
                 if ( ! empty( $members_template->member->profile_data ) ) {
                         $profile_data = $members_template->member->profile_data;
                 }
 
-                // Otherwise query for the data
+                // Otherwise query for the data.
                 if ( empty( $profile_data ) && method_exists( 'BP_XProfile_ProfileData', 'get_all_for_user' ) ) {
                         $profile_data = BP_XProfile_ProfileData::get_all_for_user( $r['user_id'] );
@@ -1253 +1250 @@
 
                 // If we're in the members loop, but the profile data has not
-                // been loaded into the global, cache it there for later use
+                // been loaded into the global, cache it there for later use.
                 if ( ! empty( $members_template->member ) && empty( $members_template->member->profile_data ) ) {
                         $members_template->member->profile_data = $profile_data;
                 }
 
-                // Get the data for the specific field requested
+                // Get the data for the specific field requested.
                 if ( ! empty( $profile_data ) && ! empty( $profile_data[ $r['field'] ]['field_type'] ) && ! empty( $profile_data[ $r['field'] ]['field_data'] ) ) {
                         $data = xprofile_format_profile_field( $profile_data[ $r['field'] ]['field_type'], $profile_data[ $r['field'] ]['field_data'] );
@@ -1397 +1394 @@
         $bp = buddypress();
 
-        // Loop through each navigation item
+        // Loop through each navigation item.
         foreach( (array) $bp->bp_nav as $nav_item ) {
 
@@ -1423 +1420 @@
                 }
 
-                // echo out the final list item
+                // Echo out the final list item.
                 echo apply_filters_ref_array( 'bp_get_loggedin_user_nav_' . $nav_item['css_id'], array( '<li id="li-nav-' . $nav_item['css_id'] . '" ' . $selected . '><a id="my-' . $nav_item['css_id'] . '" href="' . $nav_item['link'] . '">' . $nav_item['name'] . '</a></li>', &$nav_item ) );
         }
 
-        // Always add a log out list item to the end of the navigation
+        // Always add a log out list item to the end of the navigation.
         $logout_link = '<li><a id="wp-logout" href="' .  wp_logout_url( bp_get_root_domain() ) . '">' . __( 'Log Out', 'buddypress' ) . '</a></li>';
 
@@ -1490 +1487 @@
  * @see bp_get_loggedin_user_avatar() for a description of params.
  *
- * @param array|string $args
+ * @param array|string $args Array of arguments for logged in user avatar.
  */
 function bp_loggedin_user_avatar( $args = '' ) {
@@ -1539 +1536 @@
  * @see bp_get_displayed_user_avatar() for a description of params.
  *
- * @param array|string $args
+ * @param array|string $args Array of arguments for displayed user avatar.
  */
 function bp_displayed_user_avatar( $args = '' ) {
@@ -1597 +1594 @@
                 $bp = buddypress();
 
-                // If displayed user exists, return email address
+                // If displayed user exists, return email address.
                 if ( isset( $bp->displayed_user->userdata->user_email ) )
                         $retval = $bp->displayed_user->userdata->user_email;
@@ -1635 +1632 @@
          *
          * @param int $user_id ID of the user. Default: displayed user ID.
-         *
          * @return string
          */
@@ -1673 +1669 @@
         function bp_get_user_firstname( $name = false ) {
 
-                // Try to get displayed user
+                // Try to get displayed user.
                 if ( empty( $name ) )
                         $name = bp_get_displayed_user_fullname();
 
-                // Fall back on logged in user
+                // Fall back on logged in user.
                 if ( empty( $name ) )
                         $name = bp_get_loggedin_user_fullname();
@@ -1933 +1929 @@
  * @uses bp_get_signup_slug() To make sure there is a slug assigned to the page.
  * @uses bp_locate_template() To make sure a template exists to provide output.
+ *
  * @return bool True if page and template exist, false if not.
  */
@@ -2148 +2145 @@
                 global $current_site;
 
-                // In case plugins are still using this filter
+                // In case plugins are still using this filter.
                 $subdomain_base = apply_filters( 'bp_blogs_subdomain_base', preg_replace( '|^www\.|', '', $current_site->domain ) . $current_site->path );
 
@@ -2232 +2229 @@
                 $bp = buddypress();
 
-                // Check if signup_avatar_dir is passed
+                // Check if signup_avatar_dir is passed.
                 if ( !empty( $_POST['signup_avatar_dir'] ) )
                         $signup_avatar_dir = $_POST['signup_avatar_dir'];
 
-                // If not, check if global is set
+                // If not, check if global is set.
                 elseif ( !empty( $bp->signup->avatar_dir ) )
                         $signup_avatar_dir = $bp->signup->avatar_dir;
 
-                // If not, set false
+                // If not, set false.
                 else
                         $signup_avatar_dir = false;
@@ -2305 +2302 @@
                 extract( $r, EXTR_SKIP );
 
-                // Avatar DIR is found
+                // Avatar DIR is found.
                 if ( $signup_avatar_dir = bp_get_signup_avatar_dir_value() ) {
                         $gravatar_img = bp_core_fetch_avatar( array(
@@ -2318 +2315 @@
                         ) );
 
-                // No avatar DIR was found
+                // No avatar DIR was found.
                 } else {
 
-                        // Set default gravatar type
+                        // Set default gravatar type.
                         if ( empty( $bp->grav_default->user ) )
                                 $default_grav = 'wavatar';
@@ -2435 +2432 @@
         function bp_get_members_component_link( $component, $action = '', $query_args = '', $nonce = false ) {
 
-                // Must be displayed user
+                // Must be displayed user.
                 if ( !bp_displayed_user_id() )
                         return;
@@ -2441 +2438 @@
                 $bp = buddypress();
 
-                // Append $action to $url if there is no $type
+                // Append $action to $url if there is no $type.
                 if ( !empty( $action ) )
                         $url = bp_displayed_user_domain() . $bp->{$component}->slug . '/' . $action;
@@ -2447 +2444 @@
                         $url = bp_displayed_user_domain() . $bp->{$component}->slug;
 
-                // Add a slash at the end of our user url
+                // Add a slash at the end of our user url.
                 $url = trailingslashit( $url );
 
-                // Add possible query arg
+                // Add possible query arg.
                 if ( !empty( $query_args ) && is_array( $query_args ) )
                         $url = add_query_arg( $query_args, $url );
@@ -2460 +2457 @@
                         $url = wp_nonce_url( $url, $nonce );
 
-                // Return the url, if there is one
+                // Return the url, if there is one.
                 if ( !empty( $url ) )
                         return $url;

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

@@ -35 +35 @@
         public function __construct() {
 
-                // Setup widget name & description
+                // Setup widget name & description.
                 $name        = _x( '(BuddyPress) Members', 'widget name', 'buddypress' );
                 $description = __( 'A dynamic list of recently active, popular, and newest members', 'buddypress' );
 
-                // Call WP_Widget constructor
+                // Call WP_Widget constructor.
                 parent::__construct( false, $name, array(
                         'description' => $description,
@@ -45 +45 @@
                 ) );
 
-                // Maybe enqueue JS for widget
+                // Maybe enqueue JS for widget.
                 if ( is_active_widget( false, false, $this->id_base ) && ! is_admin() && ! is_network_admin() ) {
                         wp_enqueue_script( 'bp-widget-members' );
@@ -61 +61 @@
         public function widget( $args, $instance ) {
 
-                // Get widget settings
+                // Get widget settings.
                 $settings = $this->parse_settings( $instance );
 
@@ -86 +86 @@
                 $separator = apply_filters( 'bp_members_widget_separator', '|' );
 
-                // Output before widget HTMl, title (and maybe content before & after it)
+                // Output before widget HTMl, title (and maybe content before & after it).
                 echo $args['before_widget']
                    . $args['before_title']
@@ -92 +92 @@
                    . $args['after_title'];
 
-                // Setup args for querying members
+                // Setup args for querying members.
                 $members_args = array(
                         'user_id'         => 0,
@@ -165 +165 @@
          * @param array $new_instance The new instance options.
          * @param array $old_instance The old instance options.
-         *
-         * @return array $instance     The parsed options to be saved.
+         * @return array $instance The parsed options to be saved.
          */
         public function update( $new_instance, $old_instance ) {
@@ -184 +183 @@
          * @param array $instance Widget instance settings.
          *
-         * @return string
+         * @return void
          */
         public function form( $instance ) {
 
-                // Get widget settings
+                // Get widget settings.
                 $settings       = $this->parse_settings( $instance );
                 $title          = strip_tags( $settings['title'] );
@@ -233 +232 @@
          * @since 2.3.0
          *
+         * @uses bp_parse_args() To merge widget settings into defaults.
+         *
          * @param array $instance Widget instance settings.
-         *
-         * @uses bp_parse_args() To merge widget settings into defaults.
-         *
          * @return array
          */
@@ -278 +276 @@
         public function widget( $args, $instance ) {
 
-                // Get widget settings
+                // Get widget settings.
                 $settings = $this->parse_settings( $instance );
 
@@ -298 +296 @@
                    . $args['after_title'];
 
-                // Setup args for querying members
+                // Setup args for querying members.
                 $members_args = array(
                         'user_id'         => 0,
@@ -338 +336 @@
          * @param array $new_instance The new instance options.
          * @param array $old_instance The old instance options.
-         *
-         * @return array $instance     The parsed options to be saved.
+         * @return array $instance The parsed options to be saved.
          */
         public function update( $new_instance, $old_instance ) {
@@ -353 +350 @@
          *
          * @param array $instance Widget instance settings.
-         *
-         * @return string
+         * @return void
          */
         public function form( $instance ) {
 
-                // Get widget settings
+                // Get widget settings.
                 $settings    = $this->parse_settings( $instance );
                 $title       = strip_tags( $settings['title'] );
@@ -385 +381 @@
          * @since 2.3.0
          *
+         * @uses bp_parse_args() To merge widget settings into defaults.
+         *
          * @param array $instance Widget instance settings.
-         *
-         * @uses bp_parse_args() To merge widget settings into defaults.
-         *
          * @return array
          */
@@ -428 +423 @@
         public function widget( $args, $instance ) {
 
-                // Get widget settings
+                // Get widget settings.
                 $settings = $this->parse_settings( $instance );
 
@@ -448 +443 @@
                    . $args['after_title'];
 
-                // Setup args for querying members
+                // Setup args for querying members.
                 $members_args = array(
                         'user_id'         => 0,
@@ -488 +483 @@
          * @param array $new_instance The new instance options.
          * @param array $old_instance The old instance options.
-         *
          * @return array $instance The parsed options to be saved.
          */
@@ -503 +497 @@
          *
          * @param array $instance Widget instance settings.
-         *
-         * @return string
+         * @return void
          */
         public function form( $instance ) {
 
-                // Get widget settings
+                // Get widget settings.
                 $settings    = $this->parse_settings( $instance );
                 $title       = strip_tags( $settings['title'] );
@@ -535 +528 @@
          * @since 2.3.0
          *
+         * @uses bp_parse_args() To merge widget settings into defaults.
+         *
          * @param array $instance Widget instance settings.
-         *
-         * @uses bp_parse_args() To merge widget settings into defaults.
-         *
          * @return array
          */
@@ -560 +552 @@
         check_ajax_referer( 'bp_core_widget_members' );
 
-        // Setup some variables to check
+        // Setup some variables to check.
         $filter      = ! empty( $_POST['filter']      ) ? $_POST['filter']                : 'recently-active-members';
         $max_members = ! empty( $_POST['max-members'] ) ? absint( $_POST['max-members'] ) : 5;
 
-        // Determine the type of members query to perform
+        // Determine the type of members query to perform.
         switch ( $filter ) {
 
-                // Newest activated
+                // Newest activated.
                 case 'newest-members' :
                         $type = 'newest';
                         break;
 
-                // Popular by friends
+                // Popular by friends.
                 case 'popular-members' :
                         if ( bp_is_active( 'friends' ) ) {
@@ -581 +573 @@
                         break;
 
-                // Default
+                // Default.
                 case 'recently-active-members' :
                 default :
@@ -588 +580 @@
         }
 
-        // Setup args for querying members
+        // Setup args for querying members.
         $members_args = array(
                 'user_id'         => 0,
@@ -598 +590 @@
         );
 
-        // Query for members
+        // Query for members.
         if ( bp_has_members( $members_args ) ) : ?>
-                <?php echo '0[[SPLIT]]'; // return valid result. TODO: remove this. ?>
+                <?php echo '0[[SPLIT]]'; // Return valid result. TODO: remove this. ?>
                 <?php while ( bp_members() ) : bp_the_member(); ?>
                         <li class="vcard">

trunk/src/bp-members/classes/class-bp-signup.php

@@ -9 +9 @@
  */
 
+/**
+ * Class used to handle Signups.
+ */
 class BP_Signup {
 
@@ -112 +115 @@
          *
          * @param array $args the argument to retrieve desired signups.
-         *
          * @return array {
          *     @type array $signups Located signups.
@@ -150 +152 @@
                 if ( empty( $r['include'] ) ) {
 
-                        // Search terms
+                        // Search terms.
                         if ( ! empty( $r['usersearch'] ) ) {
                                 $search_terms_like = '%' . bp_esc_like( $r['usersearch'] ) . '%';
@@ -156 +158 @@
                         }
 
-                        // Activation key
+                        // Activation key.
                         if ( ! empty( $r['activation_key'] ) ) {
                                 $sql['where'][] = $wpdb->prepare( "activation_key = %s", $r['activation_key'] );
                         }
 
-                        // User login
+                        // User login.
                         if ( ! empty( $r['user_login'] ) ) {
                                 $sql['where'][] = $wpdb->prepare( "user_login = %s", $r['user_login'] );
@@ -174 +176 @@
                 }
 
-                // Implode WHERE clauses
+                // Implode WHERE clauses.
                 $sql['where'] = 'WHERE ' . implode( ' AND ', $sql['where'] );
 
@@ -194 +196 @@
 
                 // Used to calculate a diff between now & last
-                // time an activation link has been resent
+                // time an activation link has been resent.
                 $now = current_time( 'timestamp', true );
 
@@ -208 +210 @@
                         }
 
-                        // Sent date defaults to date of registration
+                        // Sent date defaults to date of registration.
                         if ( ! empty( $signup->meta['sent_date'] ) ) {
                                 $signup->date_sent = $signup->meta['sent_date'];
@@ -219 +221 @@
 
                         /**
-                         * add a boolean in case the last time an activation link
-                         * has been sent happened less than a day ago
+                         * Add a boolean in case the last time an activation link
+                         * has been sent happened less than a day ago.
                          */
                         if ( $diff < 1 * DAY_IN_SECONDS ) {
@@ -258 +260 @@
          * @since 2.0.0
          *
-         * @param array $args
-         *
+         * @param array $args Array of arguments for signup addition.
          * @return int|bool ID of newly created signup on success, false on
          *                  failure.
@@ -320 +321 @@
          * @param string $user_email    User email address.
          * @param array  $usermeta      Metadata associated with the signup.
-         *
          * @return int User id.
          */
@@ -338 +338 @@
 
                 // Update the user status to '2', ie "not activated"
-                // (0 = active, 1 = spam, 2 = not active)
+                // (0 = active, 1 = spam, 2 = not active).
                 $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->users} SET user_status = 2 WHERE ID = %d", $user_id ) );
 
@@ -347 +347 @@
                 delete_user_option( $user_id, 'user_level'   );
 
-                // Set any profile data
+                // Set any profile data.
                 if ( bp_is_active( 'xprofile' ) ) {
                         if ( ! empty( $usermeta['profile_field_ids'] ) ) {
@@ -360 +360 @@
                                         xprofile_set_field_data( $field_id, $user_id, $current_field );
 
-                                        // Save the visibility level
+                                        // Save the visibility level.
                                         $visibility_level = ! empty( $usermeta['field_' . $field_id . '_visibility'] ) ? $usermeta['field_' . $field_id . '_visibility'] : 'public';
                                         xprofile_set_field_visibility_level( $field_id, $user_id, $visibility_level );
@@ -383 +383 @@
          *
          * @param int $user_id ID of the user being checked.
-         *
          * @return int|bool The status if found, otherwise false.
          */
@@ -411 +410 @@
          *
          * @param string $key Activation key.
-         *
          * @return bool True on success, false on failure.
          */
@@ -422 +420 @@
 
                 $activated = $wpdb->update(
-                        // Signups table
+                        // Signups table.
                         buddypress()->members->table_name_signups,
                         array(
@@ -431 +429 @@
                                 'activation_key' => $key,
                         ),
-                        // Data sanitization format
+                        // Data sanitization format.
                         array(
                                 '%d',
                                 '%s',
                         ),
-                        // WHERE sanitization format
+                        // WHERE sanitization format.
                         array(
                                 '%s',
@@ -483 +481 @@
          * @since 2.0.0
          *
-         * @param array $args
-         *
-         * @return int The signup id
+         * @param array $args Array of arguments for the signup update.
+         * @return int The signup id.
          */
         public static function update( $args = array() ) {
@@ -503 +500 @@
 
                 $wpdb->update(
-                        // Signups table
+                        // Signups table.
                         buddypress()->members->table_name_signups,
-                        // Data to update
+                        // Data to update.
                         array(
                                 'meta' => serialize( $r['meta'] ),
                         ),
-                        // WHERE
+                        // WHERE.
                         array(
                                 'signup_id' => $r['signup_id'],
                         ),
-                        // Data sanitization format
+                        // Data sanitization format.
                         array(
                                 '%s',
                         ),
-                        // WHERE sanitization format
+                        // WHERE sanitization format.
                         array(
                                 '%d',
@@ -539 +536 @@
          *
          * @param array $signup_ids Single ID or list of IDs to resend.
-         *
          * @return array
          */
@@ -572 +568 @@
                         $meta['count_sent'] = $signup->count_sent + 1;
 
-                        // Send activation email
+                        // Send activation email.
                         if ( is_multisite() ) {
                                 wpmu_signup_user_notification( $signup->user_login, $signup->user_email, $signup->activation_key, serialize( $meta ) );
                         } else {
 
-                                // Check user status before sending email
+                                // Check user status before sending email.
                                 $user_id = email_exists( $signup->user_email );
 
                                 if ( ! empty( $user_id ) && 2 != self::check_user_status( $user_id ) ) {
 
-                                        // Status is not 2, so user's account has been activated
+                                        // Status is not 2, so user's account has been activated.
                                         $result['errors'][ $signup->signup_id ] = array( $signup->user_login, esc_html__( 'the sign-up has already been activated.', 'buddypress' ) );
 
-                                        // repair signups table
+                                        // Repair signups table.
                                         self::validate( $signup->activation_key );
 
                                         continue;
 
-                                // Send the validation email
+                                // Send the validation email.
                                 } else {
                                         bp_core_signup_send_validation_email( false, $signup->user_email, $signup->activation_key );
@@ -596 +592 @@
                         }
 
-                        // Update metas
+                        // Update metas.
                         $result['resent'][] = self::update( array(
                                 'signup_id' => $signup->signup_id,
@@ -629 +625 @@
          *
          * @param array $signup_ids Single ID or list of IDs to activate.
-         *
          * @return array
          */
@@ -670 +665 @@
                                 if ( empty( $user_id ) ) {
 
-                                        // Status is not 2, so user's account has been activated
+                                        // Status is not 2, so user's account has been activated.
                                         $result['errors'][ $signup->signup_id ] = array( $signup->user_login, esc_html__( 'the sign-up has already been activated.', 'buddypress' ) );
 
-                                        // repair signups table
+                                        // Repair signups table.
                                         self::validate( $signup->activation_key );
 
-                                // we have a user id, account is not active, let's delete it
+                                // We have a user id, account is not active, let's delete it.
                                 } else {
                                         $result['errors'][ $signup->signup_id ] = array( $signup->user_login, $user->get_error_message() );
@@ -712 +707 @@
          *
          * @param array $signup_ids Single ID or list of IDs to delete.
-         *
          * @return array
          */
@@ -748 +742 @@
                                 if ( 2 != self::check_user_status( $user_id ) ) {
 
-                                        // Status is not 2, so user's account has been activated
+                                        // Status is not 2, so user's account has been activated.
                                         $result['errors'][ $signup->signup_id ] = array( $signup->user_login, esc_html__( 'the sign-up has already been activated.', 'buddypress' ) );
 
-                                        // repair signups table
+                                        // Repair signups table.
                                         self::validate( $signup->activation_key );
 
-                                // we have a user id, account is not active, let's delete it
+                                // We have a user id, account is not active, let's delete it.
                                 } else {
                                         bp_core_delete_account( $user_id );
@@ -762 +756 @@
                         if ( empty( $result['errors'][ $signup->signup_id ] ) ) {
                                 $wpdb->delete(
-                                        // Signups table
+                                        // Signups table.
                                         buddypress()->members->table_name_signups,
-                                        // Where
+                                        // Where.
                                         array( 'signup_id' => $signup->signup_id, ),
-                                        // WHERE sanitization format
+                                        // WHERE sanitization format.
                                         array( '%d', )
                                 );