summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJosefFriedrich2017-03-14 20:30:17 (GMT)
committerJason Flatt2017-03-14 20:30:17 (GMT)
commit7ad9ab17fda32e1c096161799b7785c01383b23e (patch)
treef73c20360bb506e359d8eae2540d08b2fc0b5afc
parentaa4a8f62a45bb6727f57b828c04fba841f869f35 (diff)
Issue #2110243 by JosefFriedrich, ptmkenny: Fix and complete phpdoc documentation for the function privatemsg_get_link()
-rwxr-xr-xprivatemsg.module24
1 files changed, 14 insertions, 10 deletions
diff --git a/privatemsg.module b/privatemsg.module
index bf4e5e3..639ced8 100755
--- a/privatemsg.module
+++ b/privatemsg.module
@@ -1966,22 +1966,26 @@ function _privatemsg_send($message) {
}
/**
- * Returns a link to send message form for a specific users.
+ * Returns a link to the send message form for the specified users.
*
- * Contains permission checks of author/recipient, blocking and
- * if a anonymous user is involved.
+ * Contains checks for permission of the author and recipient(s), blocking, and
+ * if an anonymous user is involved.
*
- * @param $recipient
- * Recipient of the message
- * @param $account
- * Sender of the message, defaults to the current user
+ * @param mixed $recipients
+ * The user object, or an array of user objects, who will be the recipient(s)
+ * of the message.
+ * @param object $account
+ * The user object who will be the author of the message. If no object is
+ * provided, the current user will be used.
+ * @param string $subject
+ * The text for the subject of the message.
*
- * @return
- * Either FALSE or a URL string
+ * @return mixed
+ * Either FALSE or a URL string.
*
* @ingroup api
*/
-function privatemsg_get_link($recipients, $account = array(), $subject = NULL) {
+function privatemsg_get_link($recipients, $account = NULL, $subject = NULL) {
if ($account == NULL) {
global $user;
$account = $user;