CRM-20845: create alterMailingRecipients hook

diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php
index 1f75b3ab8dade666643fc291f0747713462d4338..caef0b11d0dc9ac947ef3e5285535f6b3e29efcc 100644 (file)
--- a/CRM/Utils/Hook.php
+++ b/CRM/Utils/Hook.php
@@ -2450,4 +2450,23 @@ abstract class CRM_Utils_Hook {
     );
   }
 
+  /**
+   * This hook is called before and after constructing mail recipients.
+   *  Allows user to alter filter and/or search query to fetch mail recipients
+   *
+   * @param CRM_Mailing_DAO_Mailing $mailingObject
+   * @param CRM_Mailing_Event_BAO_Queue $mailingEventQueueObject
+   * @param int $mailingJobID
+   * @param array $params
+   * @param string $context
+   *
+   */
+  public static function alterMailingRecipients(&$mailingObject, &$mailingEventQueueObject, $mailingJobID, &$params, $context) {
+    return self::singleton()->invoke(array('mailingObject', 'mailingEventQueueObject', '$mailingJobID', 'params', 'context'),
+      $mailingObject, $mailingEventQueueObject, $mailingJobID, $params, $context,
+      self::$_nullObject,
+      'civicrm_alterMailingRecipients'
+    );
+  }
+
 }