From dcbd3a55fe4091a406e8398ce5b2901c9fe89c6c Mon Sep 17 00:00:00 2001
From: "Donald A. Lobo" <lobo@civicrm.org>
Date: Mon, 14 Oct 2013 10:44:03 -0700
Subject: [PATCH] CRM-13560 - add documentation
----------------------------------------
* CRM-13560: hook_civicrm_unsubscribeGroups is undocumented
http://issues.civicrm.org/jira/browse/CRM-13560
---
CRM/Utils/Hook.php | 3 +++
1 file changed, 3 insertions(+)
diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php
index cd38ec7253..fbb789ce36 100644
--- a/CRM/Utils/Hook.php
+++ b/CRM/Utils/Hook.php
@@ -561,9 +561,12 @@ abstract class CRM_Utils_Hook {
* This hook is called when a contact unsubscribes from a mailing. It allows modules
* to override what the contacts are removed from.
*
+ * @param string $op - ignored for now
* @param int $mailing_id - the id of the mailing to unsub from
* @param int $contact_id - the id of the contact who is unsubscribing
* @param array / int $groups - array of groups the contact will be removed from
+ * @param array / int $baseGroups - array of base groups (used in smart mailings) the contact will be removed from
+ *
**/
static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
return self::singleton()->invoke(5, $op, $mailingId, $contactId, $groups, $baseGroups, 'civicrm_unsubscribeGroups');
--
2.25.1