makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-08 04:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/16468] Amend DocBlocks for user_delete()

Browse source 
PHPBB3-16468
This commit is contained in:
3D-I 2020-05-05 00:38:10 +02:00
parent 56ddf5827f
commit 7e60a3c075
1 changed files with 24 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
phpBB/includes/functions_user.php
View file

@ -424,11 +424,11 @@ function user_add($user_row, $cp_data = false, $notifications_data = null)
} }
/** /**
* Remove User * Delete User(s) and all related.
* *
* @param string $mode Either 'retain' or 'remove' * @param string $mode Mode (retain|delete)
* @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 * @param bool $retain_username True if username should be retained, false otherwise
* @return bool * @return bool
*/ */
function user_delete($mode, $user_ids, $retain_username = true) function user_delete($mode, $user_ids, $retain_username = true)
@ -462,17 +462,16 @@ function user_delete($mode, $user_ids, $retain_username = true)
} }
/** /**
* Event before a user is deleted * 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 deletion (retain/delete posts) * @var string mode Mode of posts deletion (retain|delete)
* @var array user_ids IDs of the deleted user * @var array user_ids ID(s) of the user(s) bound to be deleted
* @var mixed retain_username True if username should be retained * @var mixed retain_username True if username should be retained, false otherwise
* or false if not * @var array user_rows Array containing data of the user(s) bound to be deleted
* @var array user_rows Array containing data of the deleted users * @since 3.1.0-a1
* @since 3.1.0-a1 * @changed 3.2.4-RC1 Added user_rows
* @changed 3.2.4-RC1 Added user_rows */
*/
$vars = array('mode', 'user_ids', 'retain_username', 'user_rows'); $vars = array('mode', 'user_ids', 'retain_username', 'user_rows');
extract($phpbb_dispatcher->trigger_event('core.delete_user_before', compact($vars))); extract($phpbb_dispatcher->trigger_event('core.delete_user_before', compact($vars)));
@ -773,17 +772,16 @@ function user_delete($mode, $user_ids, $retain_username = true)
$db->sql_transaction('commit'); $db->sql_transaction('commit');
/** /**
* Event after a user is deleted * Event after of the user(s) delete action has been performed
* *
* @event core.delete_user_after * @event core.delete_user_after
* @var string mode Mode of deletion (retain/delete posts) * @var string mode Mode of posts deletion (retain|delete)
* @var array user_ids IDs of the deleted user * @var array user_ids ID(s) of the deleted user(s)
* @var mixed retain_username True if username should be retained * @var mixed retain_username True if username should be retained, false otherwise
* or false if not * @var array user_rows Array containing data of the deleted user(s)
* @var array user_rows Array containing data of the deleted users * @since 3.1.0-a1
* @since 3.1.0-a1 * @changed 3.2.2-RC1 Added user_rows
* @changed 3.2.2-RC1 Added user_rows */
*/
$vars = array('mode', 'user_ids', 'retain_username', 'user_rows'); $vars = array('mode', 'user_ids', 'retain_username', 'user_rows');
extract($phpbb_dispatcher->trigger_event('core.delete_user_after', compact($vars))); extract($phpbb_dispatcher->trigger_event('core.delete_user_after', compact($vars)));