aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@gmx.de>2012-04-13 16:26:41 +0200
committerJoas Schilling <nickvergessen@gmx.de>2012-04-13 16:26:41 +0200
commit4b6b41a1e5cb3d4ba7c896dfa4d72082aa2f069e (patch)
tree0e252543cced00dabf111624449bde23f5fc364e /phpBB/includes
parent2b2286a46c56b8a9e5444fd06eff263f880e0c78 (diff)
downloadforums-4b6b41a1e5cb3d4ba7c896dfa4d72082aa2f069e.tar
forums-4b6b41a1e5cb3d4ba7c896dfa4d72082aa2f069e.tar.gz
forums-4b6b41a1e5cb3d4ba7c896dfa4d72082aa2f069e.tar.bz2
forums-4b6b41a1e5cb3d4ba7c896dfa4d72082aa2f069e.tar.xz
forums-4b6b41a1e5cb3d4ba7c896dfa4d72082aa2f069e.zip
[ticket/10605] Add parameter documentation to phpbb_delete_user_pms
PHPBB3-10605
Diffstat (limited to 'phpBB/includes')
-rw-r--r--phpBB/includes/functions_privmsgs.php4
1 files changed, 4 insertions, 0 deletions
diff --git a/phpBB/includes/functions_privmsgs.php b/phpBB/includes/functions_privmsgs.php
index 14a6d83b2a..00bec11569 100644
--- a/phpBB/includes/functions_privmsgs.php
+++ b/phpBB/includes/functions_privmsgs.php
@@ -1085,6 +1085,10 @@ function delete_pm($user_id, $msg_ids, $folder_id)
/**
* Delete all PM(s) for a given user and delete the ones without references
+*
+* @param int $user_id ID of the user whose private messages we want to delete
+*
+* @return boolean False if there were no pms found, true otherwise.
*/
function phpbb_delete_user_pms($user_id)
{