diff options
| author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-06-26 09:32:12 -0700 |
|---|---|---|
| committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-06-26 09:32:12 -0700 |
| commit | 576216bede8b8555d70480898bf67eed1f0738a9 (patch) | |
| tree | d306417884f66854e6f26c324e300e868beb1c3d | |
| parent | cc813308a0f976cf047b9b6968188849b6a645cb (diff) | |
| download | brdo-576216bede8b8555d70480898bf67eed1f0738a9.tar.gz brdo-576216bede8b8555d70480898bf67eed1f0738a9.tar.bz2 | |
Issue #1552400 by mjonesdinero, SumeetSingh: Fix documentation for user_is_blocked, which was misleading.
| -rw-r--r-- | modules/user/user.module | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/modules/user/user.module b/modules/user/user.module index 0c2839796..47ac64273 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -823,7 +823,12 @@ function user_access($string, $account = NULL) { /** * 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) { return db_select('users') |