Changeset 8318 for trunk/bp-members/bp-members-actions.php

Timestamp:

04/24/2014 09:59:12 PM (11 years ago)

Author:

boonebgorges

Message:

Improved documentation in Members component. See #5022

File:

• trunk/bp-members/bp-members-actions.php (modified) (3 diffs)

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

@@ -16 +16 @@
 
 /**
+ * Catch a "Mark as Spammer/Not Spammer" click from the toolbar.
+ *
  * When a site admin selects "Mark as Spammer/Not Spammer" from the admin menu
  * this action will fire and mark or unmark the user and their blogs as spam.
  * Must be a site admin for this function to run.
  *
- * @package BuddyPress Core
- * @param int $user_id Optional user ID to mark as spam
- * @global object $wpdb Global WordPress Database object
+ * Note: no longer used in the current state. See the Settings component.
+ *
+ * @param int $user_id Optional. User ID to mark as spam. Defaults to displayed
+ *        user.
  */
 function bp_core_action_set_spammer_status( $user_id = 0 ) {
@@ -66 +69 @@
 
 /**
- * Allows a site admin to delete a user from the adminbar menu.
+ * Process user deletion requests.
  *
- * @package BuddyPress Core
+ * Note: No longer called here. See the Settings component.
  */
 function bp_core_action_delete_user() {
@@ -102 +105 @@
 
 /**
- * Returns the user_id for a user based on their username.
+ * Redirect to a random member page when visiting a ?random-member URL.
  *
- * @package BuddyPress Core
- * @param string $username Username to check.
  * @since BuddyPress (1.0)
  */