From b06c6d6f157513e2fc5d6eaa1e6c02d1e1046567 Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Mon, 13 Sep 2010 15:31:24 +0000
Subject: Refs #2450: Updated docs for core admin actions.

git-svn-id: http://code.elgg.org/elgg/trunk@6929 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 actions/admin/user/ban.php | 18 +++++++-----------
 1 file changed, 7 insertions(+), 11 deletions(-)

(limited to 'actions/admin/user/ban.php')

diff --git a/actions/admin/user/ban.php b/actions/admin/user/ban.php
index 1a5d9e4a9..6622673e6 100644
--- a/actions/admin/user/ban.php
+++ b/actions/admin/user/ban.php
@@ -1,23 +1,20 @@
 <?php
 /**
- * Elgg ban user
+ * Bans a user.
  *
- * @package Elgg
- * @subpackage Core
- * @author Curverider Ltd
- * @link http://elgg.org/
+ * User entities are banned by setting the 'banned' column
+ * to 'yes' in the users_entity table.
+ *
+ * @package Elgg.Core
+ * @subpackage Administration.User
  */
 
-
-// block non-admin users
 admin_gatekeeper();
 
-// Get the user
 $guid = get_input('guid');
 $obj = get_entity($guid);
 
 if (($obj instanceof ElggUser) && ($obj->canEdit())) {
-	// Now actually disable it
 	if ($obj->ban('banned')) {
 		system_message(elgg_echo('admin:user:ban:yes'));
 	} else {
@@ -27,5 +24,4 @@ if (($obj instanceof ElggUser) && ($obj->canEdit())) {
 	register_error(elgg_echo('admin:user:ban:no'));
 }
 
-forward('pg/admin/user/');
-exit;
+forward('pg/admin/user/');
\ No newline at end of file
-- 
cgit v1.2.3