Issue #1683794 by JacobSanford, somepal, Caligan: Fix docs for user_block_user_action() function

merge-requests/26/head
Jennifer Hodgdon 2013-12-20 09:00:12 -08:00
parent 92ebe7ffc9
commit 97069e4dac
1 changed files with 8 additions and 1 deletions

View File

@ -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
*/