From 7e60a3c07580ae1d7a8f3a8018bfd8508f498fe6 Mon Sep 17 00:00:00 2001
From: 3D-I <480857+3D-I@users.noreply.github.com>
Date: Tue, 5 May 2020 00:38:10 +0200
Subject: [PATCH 1/2] [ticket/16468] Amend DocBlocks for user_delete()

PHPBB3-16468
---
 phpBB/includes/functions_user.php | 50 +++++++++++++++----------------
 1 file changed, 24 insertions(+), 26 deletions(-)

diff --git a/phpBB/includes/functions_user.php b/phpBB/includes/functions_user.php
index 0eaf9c2e18..4901b8a9d4 100644
--- a/phpBB/includes/functions_user.php
+++ b/phpBB/includes/functions_user.php
@@ -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 mixed		$user_ids	Either an array of integers or an integer
- * @param bool		$retain_username
+ * @param string	$mode				Mode (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)
@@ -462,17 +462,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 mixed	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)));
 
@@ -773,17 +772,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 of 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 mixed	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)));
 

From 1b439cb6a06b66d01ce19e09d0c2b5527ff211bd Mon Sep 17 00:00:00 2001
From: 3D-I <480857+3D-I@users.noreply.github.com>
Date: Fri, 8 May 2020 23:19:04 +0200
Subject: [PATCH 2/2] [ticket/16468] Amend DocBlocks for user_delete()

PHPBB3-16468
---
 phpBB/includes/functions_user.php | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/phpBB/includes/functions_user.php b/phpBB/includes/functions_user.php
index 4901b8a9d4..f2e73229e8 100644
--- a/phpBB/includes/functions_user.php
+++ b/phpBB/includes/functions_user.php
@@ -424,9 +424,9 @@ function user_add($user_row, $cp_data = false, $notifications_data = null)
 }
 
 /**
- * Delete User(s) and all related.
+ * Delete user(s) and their related data
  *
- * @param string	$mode				Mode (retain|delete)
+ * @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
@@ -467,7 +467,7 @@ function user_delete($mode, $user_ids, $retain_username = true)
 	 * @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 mixed	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
 	 * @since 3.1.0-a1
 	 * @changed 3.2.4-RC1 Added user_rows
@@ -772,12 +772,12 @@ function user_delete($mode, $user_ids, $retain_username = true)
 	$db->sql_transaction('commit');
 
 	/**
-	 * Event after of the user(s) delete action has been performed
+	 * 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 mixed	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)
 	 * @since 3.1.0-a1
 	 * @changed 3.2.2-RC1 Added user_rows