Changeset 10322 for trunk/src/bp-members/bp-members-actions.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-actions.php (modified) (6 diffs)

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' );
+ */
 
 /**