CRM-13560 - add documentation

----------------------------------------
* CRM-13560: hook_civicrm_unsubscribeGroups is undocumented
  http://issues.civicrm.org/jira/browse/CRM-13560

diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php
index cd38ec72537065b62dd8eddda062362b9176275d..fbb789ce3661dda7d695fd7014744dc988c0229b 100644 (file)
--- 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');