summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--modules/user/user.module9
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
*/