1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-23 18:11:47 +02:00

Merge pull request #6224 from 3D-I/ticket/16789

[ticket/16789] Update user_delete() doc-block
This commit is contained in:
Marc Alexander
2021-06-29 22:33:47 +02:00

View File

@@ -425,7 +425,7 @@ function user_add($user_row, $cp_data = false, $notifications_data = null)
/** /**
* Delete user(s) and their related data * Delete user(s) and their related data
* *
* @param string $mode Mode of posts deletion (retain|delete) * @param string $mode Mode of posts deletion (retain|remove)
* @param mixed $user_ids Either an array of integers or an integer * @param mixed $user_ids Either an array of integers or an integer
* @param bool $retain_username True if username should be retained, false otherwise * @param bool $retain_username True if username should be retained, false otherwise
* @return bool * @return bool
@@ -464,7 +464,7 @@ function user_delete($mode, $user_ids, $retain_username = true)
* Event before of the performing of the user(s) delete action * Event before of the performing of the user(s) delete action
* *
* @event core.delete_user_before * @event core.delete_user_before
* @var string mode Mode of posts deletion (retain|delete) * @var string mode Mode of posts deletion (retain|remove)
* @var array user_ids ID(s) of the user(s) bound to be deleted * @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 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 * @var array user_rows Array containing data of the user(s) bound to be deleted
@@ -774,7 +774,7 @@ function user_delete($mode, $user_ids, $retain_username = true)
* Event after the user(s) delete action has been performed * Event after the user(s) delete action has been performed
* *
* @event core.delete_user_after * @event core.delete_user_after
* @var string mode Mode of posts deletion (retain|delete) * @var string mode Mode of posts deletion (retain|remove)
* @var array user_ids ID(s) of the deleted user(s) * @var array user_ids ID(s) of the deleted user(s)
* @var bool retain_username True if username should be retained, false otherwise * @var bool retain_username True if username should be retained, false otherwise
* @var array user_rows Array containing data of the deleted user(s) * @var array user_rows Array containing data of the deleted user(s)