diff --git a/phpBB/includes/functions_user.php b/phpBB/includes/functions_user.php index 8010a857ca..54fdb2ba14 100644 --- a/phpBB/includes/functions_user.php +++ b/phpBB/includes/functions_user.php @@ -423,11 +423,11 @@ function user_add($user_row, $cp_data = false, $notifications_data = null) } /** - * Remove User + * Delete user(s) and their related data * - * @param string $mode Either 'retain' or 'remove' - * @param mixed $user_ids Either an array of integers or an integer - * @param bool $retain_username + * @param string $mode Mode of posts deletion (retain|delete) + * @param mixed $user_ids Either an array of integers or an integer + * @param bool $retain_username True if username should be retained, false otherwise * @return bool */ function user_delete($mode, $user_ids, $retain_username = true) @@ -461,17 +461,16 @@ function user_delete($mode, $user_ids, $retain_username = true) } /** - * Event before a user is deleted - * - * @event core.delete_user_before - * @var string mode Mode of deletion (retain/delete posts) - * @var array user_ids IDs of the deleted user - * @var mixed retain_username True if username should be retained - * or false if not - * @var array user_rows Array containing data of the deleted users - * @since 3.1.0-a1 - * @changed 3.2.4-RC1 Added user_rows - */ + * Event before of the performing of the user(s) delete action + * + * @event core.delete_user_before + * @var string mode Mode of posts deletion (retain|delete) + * @var array user_ids ID(s) of the user(s) bound to be deleted + * @var bool retain_username True if username should be retained, false otherwise + * @var array user_rows Array containing data of the user(s) bound to be deleted + * @since 3.1.0-a1 + * @changed 3.2.4-RC1 Added user_rows + */ $vars = array('mode', 'user_ids', 'retain_username', 'user_rows'); extract($phpbb_dispatcher->trigger_event('core.delete_user_before', compact($vars))); @@ -772,17 +771,16 @@ function user_delete($mode, $user_ids, $retain_username = true) $db->sql_transaction('commit'); /** - * Event after a user is deleted - * - * @event core.delete_user_after - * @var string mode Mode of deletion (retain/delete posts) - * @var array user_ids IDs of the deleted user - * @var mixed retain_username True if username should be retained - * or false if not - * @var array user_rows Array containing data of the deleted users - * @since 3.1.0-a1 - * @changed 3.2.2-RC1 Added user_rows - */ + * Event after the user(s) delete action has been performed + * + * @event core.delete_user_after + * @var string mode Mode of posts deletion (retain|delete) + * @var array user_ids ID(s) of the deleted user(s) + * @var bool retain_username True if username should be retained, false otherwise + * @var array user_rows Array containing data of the deleted user(s) + * @since 3.1.0-a1 + * @changed 3.2.2-RC1 Added user_rows + */ $vars = array('mode', 'user_ids', 'retain_username', 'user_rows'); extract($phpbb_dispatcher->trigger_event('core.delete_user_after', compact($vars)));