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

Timestamp:

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

Author:

tw2113

Message:

More documentation cleanup for the Members component.

See #6402.

File:

• trunk/src/bp-members/bp-members-adminbar.php (modified) (11 diffs)

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;