Issue #1552400 by mjonesdinero, SumeetSingh: Fix up docs for user_is_blocked()
authorJennifer Hodgdon
Tue, 13 Nov 2012 16:39:55 +0000 (08:39 -0800)
committerJennifer Hodgdon
Tue, 13 Nov 2012 16:39:55 +0000 (08:39 -0800)
modules/user/user.module

index 406a669..99dbba9 100644 (file)
@@ -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));