diff options
| author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2013-12-20 09:00:12 -0800 |
|---|---|---|
| committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2013-12-20 09:00:12 -0800 |
| commit | 97069e4dac11f0f86a49e7728f01669f64d06d0f (patch) | |
| tree | 1aac397f4e384ad2c543c5095573324443a3381d /modules/user | |
| parent | 92ebe7ffc96238c04bdce46b05ee8644396861c8 (diff) | |
| download | brdo-97069e4dac11f0f86a49e7728f01669f64d06d0f.tar.gz brdo-97069e4dac11f0f86a49e7728f01669f64d06d0f.tar.bz2 | |
Issue #1683794 by JacobSanford, somepal, Caligan: Fix docs for user_block_user_action() function
Diffstat (limited to 'modules/user')
| -rw-r--r-- | modules/user/user.module | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/modules/user/user.module b/modules/user/user.module index 29d479323..305fec80c 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -3677,7 +3677,14 @@ function user_action_info() { } /** - * Blocks the current user. + * Blocks a specific user or the current user, if one is not specified. + * + * @param $entity + * (optional) An entity object; if it is provided and it has a uid property, + * the user with that ID is blocked. + * @param $context + * (optional) An associative array; if no user ID is found in $entity, the + * 'uid' element of this array determines the user to block. * * @ingroup actions */ |