summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2012-11-13 16:39:55 (GMT)
committer Jennifer Hodgdon2012-11-13 16:39:55 (GMT)
commitb242edc7eca03ed3e7b343825ca2f269f59979df (patch)
tree1d1e771616962b371c453aa15433e84a3495a18c
parentc82c3caf1feec5931cde808bb7fd94bb973b297b (diff)
Issue #1552400 by mjonesdinero, SumeetSingh: Fix up docs for user_is_blocked()
-rw-r--r--modules/user/user.module7
1 files changed, 6 insertions, 1 deletions
diff --git a/modules/user/user.module b/modules/user/user.module
index 406a669..99dbba9 100644
--- a/modules/user/user.module
+++ b/modules/user/user.module
@@ -540,7 +540,12 @@ function user_access($string, $account = NULL, $reset = FALSE) {
/**
* Checks for usernames blocked by user administration.
*
- * @return boolean TRUE for blocked users, FALSE for active.
+ * @param $name
+ * A string containing a name of the user.
+ *
+ * @return
+ * Object with property 'name' (the user name), if the user is blocked;
+ * FALSE if the user is not blocked.
*/
function user_is_blocked($name) {
$deny = db_fetch_object(db_query("SELECT name FROM {users} WHERE status = 0 AND name = LOWER('%s')", $name));