3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * @package CiviCRM_Hook
31 * @copyright CiviCRM LLC (c) 2004-2019
33 abstract class CRM_Utils_Hook
{
35 // Allowed values for dashboard hook content placement
36 // Default - place content below activity list
37 const DASHBOARD_BELOW
= 1;
38 // Place content above activity list
39 const DASHBOARD_ABOVE
= 2;
40 // Don't display activity list at all
41 const DASHBOARD_REPLACE
= 3;
43 // by default - place content below existing content
44 const SUMMARY_BELOW
= 1;
45 // place hook content above
46 const SUMMARY_ABOVE
= 2;
47 // create your own summaries
48 const SUMMARY_REPLACE
= 3;
50 static $_nullObject = NULL;
53 * We only need one instance of this object. So we use the singleton
54 * pattern and cache the instance in this variable
58 static private $_singleton = NULL;
63 private $commonIncluded = FALSE;
68 private $commonCiviModules = array();
71 * @var CRM_Utils_Cache_Interface
76 * Constructor and getter for the singleton instance.
81 * An instance of $config->userHookClass
83 public static function singleton($fresh = FALSE) {
84 if (self
::$_singleton == NULL ||
$fresh) {
85 $config = CRM_Core_Config
::singleton();
86 $class = $config->userHookClass
;
87 self
::$_singleton = new $class();
89 return self
::$_singleton;
93 * CRM_Utils_Hook constructor.
95 public function __construct() {
96 $this->cache
= CRM_Utils_Cache
::create(array(
98 'type' => array('ArrayCache'),
104 * Invoke a hook through the UF/CMS hook system and the extension-hook
107 * @param int $numParams
108 * Number of parameters to pass to the hook.
110 * Parameter to be passed to the hook.
112 * Parameter to be passed to the hook.
114 * Parameter to be passed to the hook.
116 * Parameter to be passed to the hook.
118 * Parameter to be passed to the hook.
120 * Parameter to be passed to the hook.
121 * @param string $fnSuffix
122 * Function suffix, this is effectively the hook name.
126 public abstract function invokeViaUF(
128 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
135 * This is a transitional adapter. It supports the legacy syntax
136 * but also accepts enough information to support Symfony Event
139 * @param array|int $names
140 * (Recommended) Array of parameter names, in order.
141 * Using an array is recommended because it enables full
142 * event-broadcasting behaviors.
143 * (Legacy) Number of parameters to pass to the hook.
144 * This is provided for transitional purposes.
151 * @param mixed $fnSuffix
154 public function invoke(
156 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
159 if (is_array($names) && !defined('CIVICRM_FORCE_LEGACY_HOOK') && \Civi\Core\Container
::isContainerBooted()) {
160 $event = \Civi\Core\Event\GenericHookEvent
::createOrdered(
162 array(&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6)
164 \Civi
::dispatcher()->dispatch('hook_' . $fnSuffix, $event);
165 return $event->getReturnValues();
168 $count = is_array($names) ?
count($names) : $names;
169 return $this->invokeViaUF($count, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $fnSuffix);
174 * @param array $numParams
186 public function commonInvoke(
188 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
192 $this->commonBuildModuleList($fnPrefix);
194 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
195 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
200 * Build the list of modules to be processed for hooks.
202 * @param string $fnPrefix
204 public function commonBuildModuleList($fnPrefix) {
205 if (!$this->commonIncluded
) {
206 // include external file
207 $this->commonIncluded
= TRUE;
209 $config = CRM_Core_Config
::singleton();
210 if (!empty($config->customPHPPathDir
)) {
211 $civicrmHooksFile = CRM_Utils_File
::addTrailingSlash($config->customPHPPathDir
) . 'civicrmHooks.php';
212 if (file_exists($civicrmHooksFile)) {
213 @include_once
$civicrmHooksFile;
217 if (!empty($fnPrefix)) {
218 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
221 $this->requireCiviModules($this->commonCiviModules
);
226 * @param $civiModules
228 * @param array $numParams
238 public function runHooks(
239 $civiModules, $fnSuffix, $numParams,
240 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
242 // $civiModules is *not* passed by reference because runHooks
243 // must be reentrant. PHP is finicky about running
244 // multiple loops over the same variable. The circumstances
245 // to reproduce the issue are pretty intricate.
248 $fnNames = $this->cache
->get($fnSuffix);
249 if (!is_array($fnNames)) {
251 if ($civiModules !== NULL) {
252 foreach ($civiModules as $module) {
253 $fnName = "{$module}_{$fnSuffix}";
254 if (function_exists($fnName)) {
255 $fnNames[] = $fnName;
258 $this->cache
->set($fnSuffix, $fnNames);
262 foreach ($fnNames as $fnName) {
264 switch ($numParams) {
266 $fResult = $fnName();
270 $fResult = $fnName($arg1);
274 $fResult = $fnName($arg1, $arg2);
278 $fResult = $fnName($arg1, $arg2, $arg3);
282 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
286 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
290 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
294 CRM_Core_Error
::fatal(ts('Invalid hook invocation'));
298 if (!empty($fResult) &&
301 $result = array_merge($result, $fResult);
305 return empty($result) ?
TRUE : $result;
311 public function requireCiviModules(&$moduleList) {
312 $civiModules = CRM_Core_PseudoConstant
::getModuleExtensions();
313 foreach ($civiModules as $civiModule) {
314 if (!file_exists($civiModule['filePath'])) {
315 CRM_Core_Session
::setStatus(
316 ts('Error loading module file (%1). Please restore the file or disable the module.',
317 array(1 => $civiModule['filePath'])),
318 ts('Warning'), 'error');
321 include_once $civiModule['filePath'];
322 $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
327 * This hook is called before a db write on some core objects.
328 * This hook does not allow the abort of the operation
331 * The type of operation being performed.
332 * @param string $objectName
333 * The name of the object.
335 * The object id if available.
336 * @param array $params
337 * The parameters used for object creation / editing.
340 * the return value is ignored
342 public static function pre($op, $objectName, $id, &$params) {
343 $event = new \Civi\Core\Event\
PreEvent($op, $objectName, $id, $params);
344 \Civi
::dispatcher()->dispatch('hook_civicrm_pre', $event);
345 return $event->getReturnValues();
349 * This hook is called after a db write on some core objects.
352 * The type of operation being performed.
353 * @param string $objectName
354 * The name of the object.
355 * @param int $objectId
356 * The unique identifier for the object.
357 * @param object $objectRef
358 * The reference to the object if available.
361 * based on op. pre-hooks return a boolean or
362 * an error message which aborts the operation
364 public static function post($op, $objectName, $objectId, &$objectRef = NULL) {
365 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
366 \Civi
::dispatcher()->dispatch('hook_civicrm_post', $event);
367 return $event->getReturnValues();
371 * This hook retrieves links from other modules and injects it into.
372 * the view contact tabs
375 * The type of operation being performed.
376 * @param string $objectName
377 * The name of the object.
378 * @param int $objectId
379 * The unique identifier for the object.
380 * @param array $links
381 * (optional) the links array (introduced in v3.2).
383 * (optional) the bitmask to show/hide links.
384 * @param array $values
385 * (optional) the values to fill the links.
388 * the return value is ignored
390 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) {
391 return self
::singleton()->invoke(array('op', 'objectName', 'objectId', 'links', 'mask', 'values'), $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
395 * This hook is invoked during the CiviCRM form preProcess phase.
397 * @param string $formName
398 * The name of the form.
399 * @param CRM_Core_Form $form
400 * Reference to the form object.
403 * the return value is ignored
405 public static function preProcess($formName, &$form) {
406 return self
::singleton()
407 ->invoke(array('formName', 'form'), $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
411 * This hook is invoked when building a CiviCRM form. This hook should also
412 * be used to set the default values of a form element
414 * @param string $formName
415 * The name of the form.
416 * @param CRM_Core_Form $form
417 * Reference to the form object.
420 * the return value is ignored
422 public static function buildForm($formName, &$form) {
423 return self
::singleton()->invoke(array('formName', 'form'), $formName, $form,
424 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
430 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
431 * any form elements, this hook should save the values in the database
433 * @param string $formName
434 * The name of the form.
435 * @param CRM_Core_Form $form
436 * Reference to the form object.
439 * the return value is ignored
441 public static function postProcess($formName, &$form) {
442 return self
::singleton()->invoke(array('formName', 'form'), $formName, $form,
443 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
444 'civicrm_postProcess'
449 * This hook is invoked during all CiviCRM form validation. An array of errors
450 * detected is returned. Else we assume validation succeeded.
452 * @param string $formName
453 * The name of the form.
454 * @param array &$fields the POST parameters as filtered by QF
455 * @param array &$files the FILES parameters as sent in by POST
456 * @param array &$form the form object
457 * @param array &$errors the array of errors.
460 * formRule hooks return a boolean or
461 * an array of error messages which display a QF Error
463 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
464 return self
::singleton()
465 ->invoke(array('formName', 'fields', 'files', 'form', 'errors'),
466 $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
470 * This hook is called after a db write on a custom table.
473 * The type of operation being performed.
474 * @param string $groupID
475 * The custom group ID.
476 * @param object $entityID
477 * The entityID of the row in the custom table.
478 * @param array $params
479 * The parameters that were sent into the calling function.
482 * the return value is ignored
484 public static function custom($op, $groupID, $entityID, &$params) {
485 return self
::singleton()
486 ->invoke(array('op', 'groupID', 'entityID', 'params'), $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
490 * This hook is called when composing the ACL where clause to restrict
491 * visibility of contacts to the logged in user
494 * The type of permission needed.
495 * @param array $tables
496 * (reference ) add the tables that are needed for the select clause.
497 * @param array $whereTables
498 * (reference ) add the tables that are needed for the where clause.
499 * @param int $contactID
500 * The contactID for whom the check is made.
501 * @param string $where
502 * The currrent where clause.
505 * the return value is ignored
507 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
508 return self
::singleton()
509 ->invoke(array('type', 'tables', 'whereTables', 'contactID', 'where'), $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
513 * This hook is called when composing the ACL where clause to restrict
514 * visibility of contacts to the logged in user
517 * The type of permission needed.
518 * @param int $contactID
519 * The contactID for whom the check is made.
520 * @param string $tableName
521 * The tableName which is being permissioned.
522 * @param array $allGroups
523 * The set of all the objects for the above table.
524 * @param array $currentGroups
525 * The set of objects that are currently permissioned for this contact.
528 * the return value is ignored
530 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
531 return self
::singleton()
532 ->invoke(array('type', 'contactID', 'tableName', 'allGroups', 'currentGroups'), $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
536 * @param string|CRM_Core_DAO $entity
537 * @param array $clauses
540 public static function selectWhereClause($entity, &$clauses) {
541 $entityName = is_object($entity) ?
_civicrm_api_get_entity_name_from_dao($entity) : $entity;
542 return self
::singleton()->invoke(array('entity', 'clauses'), $entityName, $clauses,
543 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
544 'civicrm_selectWhereClause'
549 * This hook is called when building the menu table.
551 * @param array $files
552 * The current set of files to process.
555 * the return value is ignored
557 public static function xmlMenu(&$files) {
558 return self
::singleton()->invoke(array('files'), $files,
559 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
565 * (Experimental) This hook is called when build the menu table.
567 * @param array $items
568 * List of records to include in menu table.
570 * the return value is ignored
572 public static function alterMenu(&$items) {
573 return self
::singleton()->invoke(array('items'), $items,
574 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
580 * This hook is called for declaring managed entities via API.
582 * @param array $entities
583 * List of pending entities. Each entity is an array with keys:
584 * + 'module': string; for module-extensions, this is the fully-qualifed name (e.g. "com.example.mymodule"); for CMS modules, the name is prefixed by the CMS (e.g. "drupal.mymodule")
585 * + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
586 * + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
587 * + 'params': array, the entity data as supported by the CiviCRM API
588 * + 'update' (v4.5+): string, a policy which describes when to update records
589 * - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
590 * - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
591 * + 'cleanup' (v4.5+): string, a policy which describes whether to cleanup the record when it becomes orphaned (ie when $entities no longer references the record)
592 * - 'always' (default): always delete orphaned records
593 * - 'never': never delete orphaned records
594 * - 'unused': only delete orphaned records if there are no other references to it in the DB. (This is determined by calling the API's "getrefcount" action.)
597 * the return value is ignored
599 public static function managed(&$entities) {
600 return self
::singleton()->invoke(array('entities'), $entities,
601 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
607 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
609 * @param int $contactID
610 * The contactID for whom the dashboard is being rendered.
611 * @param int $contentPlacement
612 * (output parameter) where should the hook content be displayed.
613 * relative to the activity list
616 * the html snippet to include in the dashboard
618 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
619 $retval = self
::singleton()->invoke(array('contactID', 'contentPlacement'), $contactID, $contentPlacement,
620 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
625 * Note we need this seemingly unnecessary code because in the event that the implementation
626 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
627 * though we have a default value in this function's declaration above.
629 if (!isset($contentPlacement)) {
630 $contentPlacement = self
::DASHBOARD_BELOW
;
637 * This hook is called before storing recently viewed items.
639 * @param array $recentArray
640 * An array of recently viewed or processed items, for in place modification.
644 public static function recent(&$recentArray) {
645 return self
::singleton()->invoke(array('recentArray'), $recentArray,
646 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
652 * Determine how many other records refer to a given record.
654 * @param CRM_Core_DAO $dao
655 * The item for which we want a reference count.
656 * @param array $refCounts
657 * Each item in the array is an Array with keys:
658 * - name: string, eg "sql:civicrm_email:contact_id"
659 * - type: string, eg "sql"
660 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
663 * Return is not really intended to be used.
665 public static function referenceCounts($dao, &$refCounts) {
666 return self
::singleton()->invoke(array('dao', 'refCounts'), $dao, $refCounts,
667 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
668 'civicrm_referenceCounts'
673 * This hook is called when building the amount structure for a Contribution or Event Page.
675 * @param int $pageType
676 * Is this a contribution or event page.
677 * @param CRM_Core_Form $form
678 * Reference to the form object.
679 * @param array $amount
680 * The amount structure to be displayed.
684 public static function buildAmount($pageType, &$form, &$amount) {
685 return self
::singleton()->invoke(array('pageType', 'form', 'amount'), $pageType, $form, $amount, self
::$_nullObject,
686 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
690 * This hook is called when building the state list for a particular country.
692 * @param array $countryID
693 * The country id whose states are being selected.
698 public static function buildStateProvinceForCountry($countryID, &$states) {
699 return self
::singleton()->invoke(array('countryID', 'states'), $countryID, $states,
700 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
701 'civicrm_buildStateProvinceForCountry'
706 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
709 * The array of tabs that will be displayed.
710 * @param int $contactID
711 * The contactID for whom the dashboard is being rendered.
714 * @deprecated Use tabset() instead.
716 public static function tabs(&$tabs, $contactID) {
717 return self
::singleton()->invoke(array('tabs', 'contactID'), $tabs, $contactID,
718 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
723 * This hook is called when rendering the tabs used for events and potentially
724 * contribution pages, etc.
726 * @param string $tabsetName
727 * Name of the screen or visual element.
729 * Tabs that will be displayed.
730 * @param array $context
731 * Extra data about the screen or context in which the tab is used.
735 public static function tabset($tabsetName, &$tabs, $context) {
736 return self
::singleton()->invoke(array('tabsetName', 'tabs', 'context'), $tabsetName, $tabs,
737 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
742 * This hook is called when sending an email / printing labels
744 * @param array $tokens
745 * The list of tokens that can be used for the contact.
749 public static function tokens(&$tokens) {
750 return self
::singleton()->invoke(array('tokens'), $tokens,
751 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
756 * This hook is called when sending an email / printing labels to get the values for all the
757 * tokens returned by the 'tokens' hook
759 * @param array $details
760 * The array to store the token values indexed by contactIDs (unless it a single).
761 * @param array $contactIDs
762 * An array of contactIDs.
764 * The jobID if this is associated with a CiviMail mailing.
765 * @param array $tokens
766 * The list of tokens associated with the content.
767 * @param string $className
768 * The top level className from where the hook is invoked.
772 public static function tokenValues(
779 return self
::singleton()
780 ->invoke(array('details', 'contactIDs', 'jobID', 'tokens', 'className'), $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
784 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
787 * @param object $page
788 * The page that will be rendered.
792 public static function pageRun(&$page) {
793 return self
::singleton()->invoke(array('page'), $page,
794 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
800 * This hook is called after a copy of an object has been made. The current objects are
801 * Event, Contribution Page and UFGroup
803 * @param string $objectName
804 * Name of the object.
805 * @param object $object
806 * Reference to the copy.
810 public static function copy($objectName, &$object) {
811 return self
::singleton()->invoke(array('objectName', 'object'), $objectName, $object,
812 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
818 * This hook is called when a contact unsubscribes from a mailing. It allows modules
819 * to override what the contacts are removed from.
823 * @param int $mailingId
824 * The id of the mailing to unsub from
825 * @param int $contactId
826 * The id of the contact who is unsubscribing
827 * @param array|int $groups
828 * Groups the contact will be removed from.
829 * @param array|int $baseGroups
830 * Base groups (used in smart mailings) the contact will be removed from.
835 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
836 return self
::singleton()
837 ->invoke(array('op', 'mailingId', 'contactId', 'groups', 'baseGroups'), $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
841 * This hook is called when CiviCRM needs to edit/display a custom field with options
843 * @deprecated in favor of hook_civicrm_fieldOptions
845 * @param int $customFieldID
846 * The custom field ID.
847 * @param array $options
848 * The current set of options for that custom field.
849 * You can add/remove existing options.
850 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
851 * to be careful to not overwrite the array.
852 * Only add/edit/remove the specific field options you intend to affect.
853 * @param bool $detailedFormat
854 * If true, the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
855 * @param array $selectAttributes
856 * Contain select attribute(s) if any.
860 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = array()) {
861 // Weird: $selectAttributes is inputted but not outputted.
862 return self
::singleton()->invoke(array('customFieldID', 'options', 'detailedFormat'), $customFieldID, $options, $detailedFormat,
863 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
864 'civicrm_customFieldOptions'
869 * Hook for modifying field options
871 * @param string $entity
872 * @param string $field
873 * @param array $options
874 * @param array $params
878 public static function fieldOptions($entity, $field, &$options, $params) {
879 return self
::singleton()->invoke(array('entity', 'field', 'options', 'params'), $entity, $field, $options, $params,
880 self
::$_nullObject, self
::$_nullObject,
881 'civicrm_fieldOptions'
887 * This hook is called to display the list of actions allowed after doing a search.
888 * This allows the module developer to inject additional actions or to remove existing actions.
890 * @param string $objectType
891 * The object type for this search.
892 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
893 * @param array $tasks
894 * The current set of tasks for that custom field.
895 * You can add/remove existing tasks.
896 * Each task needs to have a title (eg 'title' => ts( 'Group - add contacts')) and a class
897 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
898 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
899 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
900 * found in CRM/$objectType/Task.php.
904 public static function searchTasks($objectType, &$tasks) {
905 return self
::singleton()->invoke(array('objectType', 'tasks'), $objectType, $tasks,
906 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
907 'civicrm_searchTasks'
913 * @param array $params
917 public static function eventDiscount(&$form, &$params) {
918 return self
::singleton()->invoke(array('form', 'params'), $form, $params,
919 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
920 'civicrm_eventDiscount'
925 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
928 * The form object for which groups / mailings being displayed
929 * @param array $groups
930 * The list of groups being included / excluded
931 * @param array $mailings
932 * The list of mailings being included / excluded
936 public static function mailingGroups(&$form, &$groups, &$mailings) {
937 return self
::singleton()->invoke(array('form', 'groups', 'mailings'), $form, $groups, $mailings,
938 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
939 'civicrm_mailingGroups'
944 * (Experimental) Modify the list of template-types used for CiviMail composition.
946 * @param array $types
947 * Sequentially indexed list of template types. Each type specifies:
949 * - editorUrl: string, Angular template URL
950 * - weight: int, priority when picking a default value for new mailings
953 public static function mailingTemplateTypes(&$types) {
954 return self
::singleton()->invoke(array('types'), $types, self
::$_nullObject, self
::$_nullObject,
955 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
956 'civicrm_mailingTemplateTypes'
961 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
963 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
964 * You can use it to alter the membership types when first loaded, or after submission
965 * (for example if you want to gather data in the form and use it to alter the fees).
968 * The form object that is presenting the page
969 * @param array $membershipTypes
970 * The array of membership types and their amount
974 public static function membershipTypeValues(&$form, &$membershipTypes) {
975 return self
::singleton()->invoke(array('form', 'membershipTypes'), $form, $membershipTypes,
976 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
977 'civicrm_membershipTypeValues'
982 * This hook is called when rendering the contact summary.
984 * @param int $contactID
985 * The contactID for whom the summary is being rendered
986 * @param mixed $content
987 * @param int $contentPlacement
988 * Specifies where the hook content should be displayed relative to the
992 * The html snippet to include in the contact summary
994 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
995 return self
::singleton()->invoke(array('contactID', 'content', 'contentPlacement'), $contactID, $content, $contentPlacement,
996 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1002 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
1003 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
1004 * If you want to limit the contacts returned to a specific group, or some other criteria
1005 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
1006 * The hook is called when the query is executed to get the list of contacts to display.
1008 * @param mixed $query
1009 * - the query that will be executed (input and output parameter);.
1010 * It's important to realize that the ACL clause is built prior to this hook being fired,
1011 * so your query will ignore any ACL rules that may be defined.
1012 * Your query must return two columns:
1013 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
1015 * @param string $queryText
1016 * The name string to execute the query against (this is the value being typed in by the user).
1017 * @param string $context
1018 * The context in which this ajax call is being made (for example: 'customfield', 'caseview').
1020 * The id of the object for which the call is being made.
1021 * For custom fields, it will be the custom field id
1025 public static function contactListQuery(&$query, $queryText, $context, $id) {
1026 return self
::singleton()->invoke(array('query', 'queryText', 'context', 'id'), $query, $queryText, $context, $id,
1027 self
::$_nullObject, self
::$_nullObject,
1028 'civicrm_contactListQuery'
1033 * Hook definition for altering payment parameters before talking to a payment processor back end.
1035 * Definition will look like this:
1037 * function hook_civicrm_alterPaymentProcessorParams(
1043 * @param CRM_Core_Payment $paymentObj
1044 * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
1045 * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
1046 * @param array &$rawParams
1047 * array of params as passed to to the processor
1048 * @param array &$cookedParams
1049 * params after the processor code has translated them into its own key/value pairs
1052 * This return is not really intended to be used.
1054 public static function alterPaymentProcessorParams(
1059 return self
::singleton()->invoke(array('paymentObj', 'rawParams', 'cookedParams'), $paymentObj, $rawParams, $cookedParams,
1060 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1061 'civicrm_alterPaymentProcessorParams'
1066 * This hook is called when an email is about to be sent by CiviCRM.
1068 * @param array $params
1069 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
1070 * returnPath, replyTo, headers, attachments (array)
1071 * @param string $context
1072 * The context in which the hook is being invoked, eg 'civimail'.
1076 public static function alterMailParams(&$params, $context = NULL) {
1077 return self
::singleton()->invoke(array('params', 'context'), $params, $context,
1078 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1079 'civicrm_alterMailParams'
1084 * This hook is called when membership status is being calculated.
1086 * @param array $membershipStatus
1087 * Membership status details as determined - alter if required.
1088 * @param array $arguments
1089 * Arguments passed in to calculate date.
1094 * - 'exclude_is_admin'
1095 * - 'membership_type_id'
1096 * @param array $membership
1097 * Membership details from the calling function.
1101 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
1102 return self
::singleton()->invoke(array('membershipStatus', 'arguments', 'membership'), $membershipStatus, $arguments,
1103 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1104 'civicrm_alterCalculatedMembershipStatus'
1109 * This hook is called after getting the content of the mail and before tokenizing it.
1111 * @param array $content
1112 * Array fields include: html, text, subject
1116 public static function alterMailContent(&$content) {
1117 return self
::singleton()->invoke(array('content'), $content,
1118 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1119 'civicrm_alterMailContent'
1124 * This hook is called when rendering the Manage Case screen.
1126 * @param int $caseID
1130 * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
1131 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
1133 public static function caseSummary($caseID) {
1134 return self
::singleton()->invoke(array('caseID'), $caseID,
1135 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1136 'civicrm_caseSummary'
1141 * This hook is called when locating CiviCase types.
1143 * @param array $caseTypes
1147 public static function caseTypes(&$caseTypes) {
1148 return self
::singleton()
1149 ->invoke(array('caseTypes'), $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
1153 * This hook is called soon after the CRM_Core_Config object has ben initialized.
1154 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1156 * @param CRM_Core_Config|array $config
1161 public static function config(&$config) {
1162 return self
::singleton()->invoke(array('config'), $config,
1163 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1169 * This hooks allows to change option values.
1171 * @deprecated in favor of hook_civicrm_fieldOptions
1173 * @param array $options
1174 * Associated array of option values / id
1175 * @param string $groupName
1180 public static function optionValues(&$options, $groupName) {
1181 return self
::singleton()->invoke(array('options', 'groupName'), $options, $groupName,
1182 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1183 'civicrm_optionValues'
1188 * This hook allows modification of the navigation menu.
1190 * @param array $params
1191 * Associated array of navigation menu entry to Modify/Add
1195 public static function navigationMenu(&$params) {
1196 return self
::singleton()->invoke(array('params'), $params,
1197 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1198 'civicrm_navigationMenu'
1203 * This hook allows modification of the data used to perform merging of duplicates.
1205 * @param string $type
1206 * The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1207 * @param array $data
1208 * The data, as described in $type.
1209 * @param int $mainId
1210 * Contact_id of the contact that survives the merge.
1211 * @param int $otherId
1212 * Contact_id of the contact that will be absorbed and deleted.
1213 * @param array $tables
1214 * When $type is "sqls", an array of tables as it may have been handed to the calling function.
1218 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1219 return self
::singleton()->invoke(array('type', 'data', 'mainId', 'otherId', 'tables'), $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
1223 * This hook allows modification of the data calculated for merging locations.
1225 * @param array $blocksDAO
1226 * Array of location DAO to be saved. These are arrays in 2 keys 'update' & 'delete'.
1227 * @param int $mainId
1228 * Contact_id of the contact that survives the merge.
1229 * @param int $otherId
1230 * Contact_id of the contact that will be absorbed and deleted.
1231 * @param array $migrationInfo
1232 * Calculated migration info, informational only.
1236 public static function alterLocationMergeData(&$blocksDAO, $mainId, $otherId, $migrationInfo) {
1237 return self
::singleton()->invoke(array('blocksDAO', 'mainId', 'otherId', 'migrationInfo'), $blocksDAO, $mainId, $otherId, $migrationInfo, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterLocationMergeData');
1241 * This hook provides a way to override the default privacy behavior for notes.
1243 * @param array &$noteValues
1244 * Associative array of values for this note
1248 public static function notePrivacy(&$noteValues) {
1249 return self
::singleton()->invoke(array('noteValues'), $noteValues,
1250 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1251 'civicrm_notePrivacy'
1256 * This hook is called before record is exported as CSV.
1258 * @param string $exportTempTable
1259 * Name of the temporary export table used during export.
1260 * @param array $headerRows
1261 * Header rows for output.
1262 * @param array $sqlColumns
1264 * @param int $exportMode
1265 * Export mode ( contact, contribution, etc...).
1266 * @param string $componentTable
1267 * Name of temporary table
1269 * Array of object's ids
1273 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, &$exportMode, &$componentTable, &$ids) {
1274 return self
::singleton()->invoke(array('exportTempTable', 'headerRows', 'sqlColumns', 'exportMode', 'componentTable', 'ids'),
1275 $exportTempTable, $headerRows, $sqlColumns,
1276 $exportMode, $componentTable, $ids,
1282 * This hook allows modification of the queries constructed from dupe rules.
1284 * @param string $obj
1285 * Object of rulegroup class.
1286 * @param string $type
1287 * Type of queries e.g table / threshold.
1288 * @param array $query
1293 public static function dupeQuery($obj, $type, &$query) {
1294 return self
::singleton()->invoke(array('obj', 'type', 'query'), $obj, $type, $query,
1295 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1301 * Check for duplicate contacts
1303 * @param array $dedupeParams
1304 * Array of params for finding duplicates: [
1305 * '{parameters returned by CRM_Dedupe_Finder::formatParams}
1306 * 'check_permission' => TRUE/FALSE;
1307 * 'contact_type' => $contactType;
1309 * 'rule_group_id' => $ruleGroupID;
1310 * 'excludedContactIDs' => $excludedContactIDs;
1311 * @param array $dedupeResults
1312 * Array of results ['handled' => TRUE/FALSE, 'ids' => array of IDs of duplicate contacts]
1313 * @param array $contextParams
1314 * The context if relevant, eg. ['event_id' => X]
1318 public static function findDuplicates($dedupeParams, &$dedupeResults, $contextParams) {
1319 return self
::singleton()
1320 ->invoke(array('dedupeParams', 'dedupeResults', 'contextParams'), $dedupeParams, $dedupeResults, $contextParams, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_findDuplicates');
1324 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1326 * @param string $type
1327 * Type of mail processed: 'activity' OR 'mailing'.
1328 * @param array &$params the params that were sent to the CiviCRM API function
1329 * @param object $mail
1330 * The mail object which is an ezcMail class.
1331 * @param array &$result the result returned by the api call
1332 * @param string $action
1333 * (optional ) the requested action to be performed if the types was 'mailing'.
1337 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1338 return self
::singleton()
1339 ->invoke(array('type', 'params', 'mail', 'result', 'action'), $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1343 * This hook is called after a row has been processed and the
1344 * record (and associated records imported
1346 * @param string $object
1347 * Object being imported (for now Contact only, later Contribution, Activity,.
1348 * Participant and Member)
1349 * @param string $usage
1350 * Hook usage/location (for now process only, later mapping and others).
1351 * @param string $objectRef
1352 * Import record object.
1353 * @param array $params
1354 * Array with various key values: currently.
1355 * contactID - contact id
1356 * importID - row id in temp table
1357 * importTempTable - name of tempTable
1358 * fieldHeaders - field headers
1359 * fields - import fields
1363 public static function import($object, $usage, &$objectRef, &$params) {
1364 return self
::singleton()->invoke(array('object', 'usage', 'objectRef', 'params'), $object, $usage, $objectRef, $params,
1365 self
::$_nullObject, self
::$_nullObject,
1371 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1372 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1374 * @param string $entity
1375 * The API entity (like contact).
1376 * @param string $action
1377 * The API action (like get).
1378 * @param array &$params the API parameters
1379 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1383 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1384 return self
::singleton()->invoke(array('entity', 'action', 'params', 'permissions'), $entity, $action, $params, $permissions,
1385 self
::$_nullObject, self
::$_nullObject,
1386 'civicrm_alterAPIPermissions'
1391 * @param CRM_Core_DAO $dao
1395 public static function postSave(&$dao) {
1396 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1397 return self
::singleton()->invoke(array('dao'), $dao,
1398 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1404 * This hook allows user to customize context menu Actions on contact summary page.
1406 * @param array $actions
1407 * Array of all Actions in contextmenu.
1408 * @param int $contactID
1409 * ContactID for the summary page.
1413 public static function summaryActions(&$actions, $contactID = NULL) {
1414 return self
::singleton()->invoke(array('actions', 'contactID'), $actions, $contactID,
1415 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1416 'civicrm_summaryActions'
1421 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1422 * This enables us hook implementors to modify both the headers and the rows
1424 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1425 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1427 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1428 * you want displayed. This is a hackish, but avoids template modification.
1430 * @param string $objectName
1431 * The component name that we are doing the search.
1432 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1433 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1434 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1435 * @param array $selector
1436 * the selector object. Allows you access to the context of the search
1439 * modify the header and values object to pass the data you need
1441 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1442 return self
::singleton()->invoke(array('objectName', 'headers', 'rows', 'selector'), $objectName, $headers, $rows, $selector,
1443 self
::$_nullObject, self
::$_nullObject,
1444 'civicrm_searchColumns'
1449 * This hook is called when uf groups are being built for a module.
1451 * @param string $moduleName
1453 * @param array $ufGroups
1454 * Array of ufgroups for a module.
1458 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1459 return self
::singleton()->invoke(array('moduleName', 'ufGroups'), $moduleName, $ufGroups,
1460 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1461 'civicrm_buildUFGroupsForModule'
1466 * This hook is called when we are determining the contactID for a specific
1469 * @param string $email
1470 * The email address.
1471 * @param int $contactID
1472 * The contactID that matches this email address, IF it exists.
1473 * @param array $result
1474 * (reference) has two fields.
1475 * contactID - the new (or same) contactID
1476 * action - 3 possible values:
1477 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1478 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1479 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1483 public static function emailProcessorContact($email, $contactID, &$result) {
1484 return self
::singleton()->invoke(array('email', 'contactID', 'result'), $email, $contactID, $result,
1485 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1486 'civicrm_emailProcessorContact'
1491 * Hook definition for altering the generation of Mailing Labels.
1493 * @param array $args
1494 * An array of the args in the order defined for the tcpdf multiCell api call.
1495 * with the variable names below converted into string keys (ie $w become 'w'
1496 * as the first key for $args)
1497 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1498 * float $h Cell minimum height. The cell extends automatically if needed.
1499 * string $txt String to print
1500 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1501 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1502 * a string containing some or all of the following characters (in any order):
1503 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1504 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1505 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1506 * (default value when $ishtml=false)</li></ul>
1507 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1508 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1509 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1510 * float $x x position in user units
1511 * float $y y position in user units
1512 * boolean $reseth if true reset the last cell height (default true).
1513 * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1514 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1515 * necessary</li><li>4 = forced character spacing</li></ul>
1516 * boolean $ishtml set to true if $txt is HTML content (default = false).
1517 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1518 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1519 * or 0 for disable this feature. This feature works only when $ishtml=false.
1523 public static function alterMailingLabelParams(&$args) {
1524 return self
::singleton()->invoke(array('args'), $args,
1525 self
::$_nullObject, self
::$_nullObject,
1526 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1527 'civicrm_alterMailingLabelParams'
1532 * This hooks allows alteration of generated page content.
1535 * Previously generated content.
1537 * Context of content - page or form.
1539 * The file name of the tpl.
1541 * A reference to the page or form object.
1545 public static function alterContent(&$content, $context, $tplName, &$object) {
1546 return self
::singleton()->invoke(array('content', 'context', 'tplName', 'object'), $content, $context, $tplName, $object,
1547 self
::$_nullObject, self
::$_nullObject,
1548 'civicrm_alterContent'
1553 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1554 * altercontent hook as the content has already been rendered through the tpl at that point
1557 * Previously generated content.
1559 * Reference to the form object.
1561 * Context of content - page or form.
1563 * Reference the file name of the tpl.
1567 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1568 return self
::singleton()->invoke(array('formName', 'form', 'context', 'tplName'), $formName, $form, $context, $tplName,
1569 self
::$_nullObject, self
::$_nullObject,
1570 'civicrm_alterTemplateFile'
1575 * This hook collects the trigger definition from all components.
1578 * @param string $tableName
1579 * (optional) the name of the table that we are interested in only.
1581 * @internal param \reference $triggerInfo to an array of trigger information
1582 * each element has 4 fields:
1583 * table - array of tableName
1584 * when - BEFORE or AFTER
1585 * event - array of eventName - INSERT OR UPDATE OR DELETE
1586 * sql - array of statements optionally terminated with a ;
1587 * a statement can use the tokes {tableName} and {eventName}
1588 * to do token replacement with the table / event. This allows
1589 * templatizing logging and other hooks
1592 public static function triggerInfo(&$info, $tableName = NULL) {
1593 return self
::singleton()->invoke(array('info', 'tableName'), $info, $tableName,
1594 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1596 'civicrm_triggerInfo'
1600 * This hook allows changes to the spec of which tables to log.
1602 * @param array $logTableSpec
1606 public static function alterLogTables(&$logTableSpec) {
1607 return self
::singleton()->invoke(array('logTableSpec'), $logTableSpec, $_nullObject,
1608 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1610 'civicrm_alterLogTables'
1615 * This hook is called when a module-extension is installed.
1616 * Each module will receive hook_civicrm_install during its own installation (but not during the
1617 * installation of unrelated modules).
1619 public static function install() {
1620 return self
::singleton()->invoke(0, self
::$_nullObject,
1621 self
::$_nullObject, self
::$_nullObject,
1622 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1628 * This hook is called when a module-extension is uninstalled.
1629 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1630 * uninstallation of unrelated modules).
1632 public static function uninstall() {
1633 return self
::singleton()->invoke(0, self
::$_nullObject,
1634 self
::$_nullObject, self
::$_nullObject,
1635 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1641 * This hook is called when a module-extension is re-enabled.
1642 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1643 * re-enablement of unrelated modules).
1645 public static function enable() {
1646 return self
::singleton()->invoke(0, self
::$_nullObject,
1647 self
::$_nullObject, self
::$_nullObject,
1648 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1654 * This hook is called when a module-extension is disabled.
1655 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1656 * disablement of unrelated modules).
1658 public static function disable() {
1659 return self
::singleton()->invoke(0, self
::$_nullObject,
1660 self
::$_nullObject, self
::$_nullObject,
1661 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1669 * This hook is called when the browser is being re-directed and allows the url
1672 * @param \Psr\Http\Message\UriInterface $url
1673 * @param array $context
1674 * Additional information about context
1675 * - output - if this is 'json' then it will return json.
1678 * the return value is ignored
1680 public static function alterRedirect(&$url, &$context) {
1681 return self
::singleton()->invoke(array('url', 'context'), $url,
1682 $context, self
::$_nullObject,
1683 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1684 'civicrm_alterRedirect'
1695 public static function alterReportVar($varType, &$var, &$object) {
1696 return self
::singleton()->invoke(array('varType', 'var', 'object'), $varType, $var, $object,
1698 self
::$_nullObject, self
::$_nullObject,
1699 'civicrm_alterReportVar'
1704 * This hook is called to drive database upgrades for extension-modules.
1707 * The type of operation being performed; 'check' or 'enqueue'.
1708 * @param CRM_Queue_Queue $queue
1709 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1712 * NULL, if $op is 'enqueue'.
1713 * TRUE, if $op is 'check' and upgrades are pending.
1714 * FALSE, if $op is 'check' and upgrades are not pending.
1716 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1717 return self
::singleton()->invoke(array('op', 'queue'), $op, $queue,
1718 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1725 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1727 * @param array $params
1728 * The mailing parameters. Array fields include: groupName, from, toName,
1729 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1730 * attachments (array)
1734 public static function postEmailSend(&$params) {
1735 return self
::singleton()->invoke(array('params'), $params,
1736 self
::$_nullObject, self
::$_nullObject,
1737 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1738 'civicrm_postEmailSend'
1743 * This hook is called when a CiviMail mailing has completed
1745 * @param int $mailingId
1750 public static function postMailing($mailingId) {
1751 return self
::singleton()->invoke(array('mailingId'), $mailingId,
1752 self
::$_nullObject, self
::$_nullObject,
1753 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1754 'civicrm_postMailing'
1759 * This hook is called when Settings specifications are loaded.
1761 * @param array $settingsFolders
1762 * List of paths from which to derive metadata
1766 public static function alterSettingsFolders(&$settingsFolders) {
1767 return self
::singleton()->invoke(array('settingsFolders'), $settingsFolders,
1768 self
::$_nullObject, self
::$_nullObject,
1769 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1770 'civicrm_alterSettingsFolders'
1775 * This hook is called when Settings have been loaded from the xml
1776 * It is an opportunity for hooks to alter the data
1778 * @param array $settingsMetaData
1779 * Settings Metadata.
1780 * @param int $domainID
1781 * @param mixed $profile
1785 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1786 return self
::singleton()->invoke(array('settingsMetaData', 'domainID', 'profile'), $settingsMetaData,
1787 $domainID, $profile,
1788 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1789 'civicrm_alterSettingsMetaData'
1794 * This hook is called before running an api call.
1796 * @param API_Wrapper[] $wrappers
1797 * (see CRM_Utils_API_ReloadOption as an example)
1798 * @param mixed $apiRequest
1801 * The return value is ignored
1803 public static function apiWrappers(&$wrappers, $apiRequest) {
1804 return self
::singleton()
1805 ->invoke(array('wrappers', 'apiRequest'), $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1806 self
::$_nullObject, 'civicrm_apiWrappers'
1811 * This hook is called before running pending cron jobs.
1813 * @param CRM_Core_JobManager $jobManager
1816 * The return value is ignored.
1818 public static function cron($jobManager) {
1819 return self
::singleton()->invoke(array('jobManager'),
1820 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1826 * This hook is called when loading CMS permissions; use this hook to modify
1827 * the array of system permissions for CiviCRM.
1829 * @param array $permissions
1830 * Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1831 * the format of this array.
1834 * The return value is ignored
1836 public static function permission(&$permissions) {
1837 return self
::singleton()->invoke(array('permissions'), $permissions,
1838 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1839 'civicrm_permission'
1844 * This hook is called when checking permissions; use this hook to dynamically
1845 * escalate user permissions in certain use cases (cf. CRM-19256).
1847 * @param string $permission
1848 * The name of an atomic permission, ie. 'access deleted contacts'
1849 * @param bool $granted
1850 * Whether this permission is currently granted. The hook can change this value.
1851 * @param int $contactId
1852 * Contact whose permissions we are checking (if null, assume current user).
1855 * The return value is ignored
1857 public static function permission_check($permission, &$granted, $contactId) {
1858 return self
::singleton()->invoke(array('permission', 'granted', 'contactId'), $permission, $granted, $contactId,
1859 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1860 'civicrm_permission_check'
1865 * @param CRM_Core_Exception Exception $exception
1866 * @param mixed $request
1867 * Reserved for future use.
1869 public static function unhandledException($exception, $request = NULL) {
1870 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
1871 \Civi
::dispatcher()->dispatch('hook_civicrm_unhandled_exception', $event);
1875 * This hook is called for declaring managed entities via API.
1877 * Note: This is a preboot hook. It will dispatch via the extension/module
1878 * subsystem but *not* the Symfony EventDispatcher.
1880 * @param array[] $entityTypes
1881 * List of entity types; each entity-type is an array with keys:
1882 * - name: string, a unique short name (e.g. "ReportInstance")
1883 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1884 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
1885 * - fields_callback: array, list of callables which manipulates field list
1886 * - links_callback: array, list of callables which manipulates fk list
1889 * The return value is ignored
1891 public static function entityTypes(&$entityTypes) {
1892 return self
::singleton()->invoke(array('entityTypes'), $entityTypes, self
::$_nullObject, self
::$_nullObject,
1893 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
1898 * Build a description of available hooks.
1900 * @param \Civi\Core\CiviEventInspector $inspector
1902 public static function eventDefs($inspector) {
1903 $event = \Civi\Core\Event\GenericHookEvent
::create(array(
1904 'inspector' => $inspector,
1906 Civi
::dispatcher()->dispatch('hook_civicrm_eventDefs', $event);
1910 * This hook is called while preparing a profile form.
1912 * @param string $profileName
1915 public static function buildProfile($profileName) {
1916 return self
::singleton()->invoke(array('profileName'), $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1917 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
1921 * This hook is called while validating a profile form submission.
1923 * @param string $profileName
1926 public static function validateProfile($profileName) {
1927 return self
::singleton()->invoke(array('profileName'), $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1928 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
1932 * This hook is called processing a valid profile form submission.
1934 * @param string $profileName
1937 public static function processProfile($profileName) {
1938 return self
::singleton()->invoke(array('profileName'), $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1939 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
1943 * This hook is called while preparing a read-only profile screen
1945 * @param string $profileName
1948 public static function viewProfile($profileName) {
1949 return self
::singleton()->invoke(array('profileName'), $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1950 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
1954 * This hook is called while preparing a list of contacts (based on a profile)
1956 * @param string $profileName
1959 public static function searchProfile($profileName) {
1960 return self
::singleton()->invoke(array('profileName'), $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1961 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
1965 * This hook is invoked when building a CiviCRM name badge.
1967 * @param string $labelName
1968 * String referencing name of badge format.
1969 * @param object $label
1970 * Reference to the label object.
1971 * @param array $format
1972 * Array of format data.
1973 * @param array $participant
1974 * Array of participant values.
1977 * the return value is ignored
1979 public static function alterBadge($labelName, &$label, &$format, &$participant) {
1980 return self
::singleton()
1981 ->invoke(array('labelName', 'label', 'format', 'participant'), $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
1986 * This hook is called before encoding data in barcode.
1988 * @param array $data
1989 * Associated array of values available for encoding.
1990 * @param string $type
1991 * Type of barcode, classic barcode or QRcode.
1992 * @param string $context
1993 * Where this hooks is invoked.
1997 public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
1998 return self
::singleton()->invoke(array('data', 'type', 'context'), $data, $type, $context, self
::$_nullObject,
1999 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
2003 * Modify or replace the Mailer object used for outgoing mail.
2005 * @param object $mailer
2006 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2007 * @param string $driver
2008 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2009 * @param array $params
2010 * The default mailer config options
2013 * @see Mail::factory
2015 public static function alterMailer(&$mailer, $driver, $params) {
2016 return self
::singleton()
2017 ->invoke(array('mailer', 'driver', 'params'), $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
2021 * Deprecated: Misnamed version of alterMailer(). Remove post-4.7.x.
2022 * Modify or replace the Mailer object used for outgoing mail.
2024 * @param object $mailer
2025 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2026 * @param string $driver
2027 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2028 * @param array $params
2029 * The default mailer config options
2032 * @see Mail::factory
2035 public static function alterMail(&$mailer, $driver, $params) {
2036 // This has been deprecated on the premise it MIGHT be called externally for a long time.
2037 // We don't have a clear policy on how much we support external extensions calling internal
2038 // hooks (ie. in general we say 'don't call internal functions', but some hooks like pre hooks
2039 // are expected to be called externally.
2040 // It's really really unlikely anyone uses this - but let's add deprecations for a couple
2041 // of releases first.
2042 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Utils_Hook::alterMailer');
2043 return CRM_Utils_Hook
::alterMailer($mailer, $driver, $params);
2047 * This hook is called while building the core search query,
2048 * so hook implementers can provide their own query objects which alters/extends core search.
2050 * @param array $queryObjects
2051 * @param string $type
2055 public static function queryObjects(&$queryObjects, $type = 'Contact') {
2056 return self
::singleton()
2057 ->invoke(array('queryObjects', 'type'), $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
2061 * This hook is called while viewing contact dashboard.
2063 * @param array $availableDashlets
2064 * List of dashlets; each is formatted per api/v3/Dashboard
2065 * @param array $defaultDashlets
2066 * List of dashlets; each is formatted per api/v3/DashboardContact
2070 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
2071 return self
::singleton()
2072 ->invoke(array('availableDashlets', 'defaultDashlets'), $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
2076 * This hook is called before a case merge (or a case reassign)
2078 * @param int $mainContactId
2079 * @param int $mainCaseId
2080 * @param int $otherContactId
2081 * @param int $otherCaseId
2082 * @param bool $changeClient
2086 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2087 return self
::singleton()
2088 ->invoke(array('mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'), $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
2092 * This hook is called after a case merge (or a case reassign)
2094 * @param int $mainContactId
2095 * @param int $mainCaseId
2096 * @param int $otherContactId
2097 * @param int $otherCaseId
2098 * @param bool $changeClient
2102 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2103 return self
::singleton()
2104 ->invoke(array('mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'), $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
2109 * Add a hook for altering the display name
2111 * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
2113 * @param string $displayName
2114 * @param int $contactId
2115 * @param object $dao
2116 * The contact object.
2120 public static function alterDisplayName(&$displayName, $contactId, $dao) {
2121 return self
::singleton()->invoke(array('displayName', 'contactId', 'dao'),
2122 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
2123 self
::$_nullObject, 'civicrm_contact_get_displayname'
2128 * Modify the CRM_Core_Resources settings data.
2130 * @param array $data
2131 * @see CRM_Core_Resources::addSetting
2133 public static function alterResourceSettings(&$data) {
2134 $event = \Civi\Core\Event\GenericHookEvent
::create(array(
2137 Civi
::dispatcher()->dispatch('hook_civicrm_alterResourceSettings', $event);
2141 * EXPERIMENTAL: This hook allows one to register additional Angular modules
2143 * @param array $angularModules
2144 * List of modules. Each module defines:
2145 * - ext: string, the CiviCRM extension which hosts the files.
2146 * - js: array, list of JS files or globs.
2147 * - css: array, list of CSS files or globs.
2148 * - partials: array, list of base-dirs containing HTML.
2149 * - requires: array, list of required Angular modules.
2150 * - basePages: array, uncondtionally load this module onto the given Angular pages. [v4.7.21+]
2151 * If omitted, default to "array('civicrm/a')" for backward compat.
2152 * For a utility that should only be loaded on-demand, use "array()".
2153 * For a utility that should be loaded in all pages use, "array('*')".
2155 * the return value is ignored
2158 * function mymod_civicrm_angularModules(&$angularModules) {
2159 * $angularModules['myAngularModule'] = array(
2160 * 'ext' => 'org.example.mymod',
2161 * 'js' => array('js/myAngularModule.js'),
2163 * $angularModules['myBigAngularModule'] = array(
2164 * 'ext' => 'org.example.mymod',
2165 * 'js' => array('js/part1.js', 'js/part2.js', 'ext://other.ext.name/file.js', 'assetBuilder://dynamicAsset.js'),
2166 * 'css' => array('css/myAngularModule.css', 'ext://other.ext.name/file.css', 'assetBuilder://dynamicAsset.css'),
2167 * 'partials' => array('partials/myBigAngularModule'),
2168 * 'requires' => array('otherModuleA', 'otherModuleB'),
2169 * 'basePages' => array('civicrm/a'),
2174 public static function angularModules(&$angularModules) {
2175 return self
::singleton()->invoke(array('angularModules'), $angularModules,
2176 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2177 'civicrm_angularModules'
2182 * Alter the definition of some Angular HTML partials.
2184 * @param \Civi\Angular\Manager $angular
2187 * function example_civicrm_alterAngular($angular) {
2188 * $changeSet = \Civi\Angular\ChangeSet::create('mychanges')
2189 * ->alterHtml('~/crmMailing/EditMailingCtrl/2step.html', function(phpQueryObject $doc) {
2190 * $doc->find('[ng-form="crmMailingSubform"]')->attr('cat-stevens', 'ts(\'wild world\')');
2193 * $angular->add($changeSet);
2197 public static function alterAngular($angular) {
2198 $event = \Civi\Core\Event\GenericHookEvent
::create(array(
2199 'angular' => $angular,
2201 Civi
::dispatcher()->dispatch('hook_civicrm_alterAngular', $event);
2205 * This hook is called whenever the system builds a new copy of
2206 * semi-static asset.
2208 * @param string $asset
2209 * The name of the asset.
2210 * Ex: 'angular.json'
2211 * @param array $params
2212 * List of optional arguments which influence the content.
2213 * Note: Params are immutable because they are part of the cache-key.
2214 * @param string $mimeType
2215 * Initially, NULL. Modify to specify the mime-type.
2216 * @param string $content
2217 * Initially, NULL. Modify to specify the rendered content.
2219 * the return value is ignored
2221 public static function buildAsset($asset, $params, &$mimeType, &$content) {
2222 return self
::singleton()->invoke(array('asset', 'params', 'mimeType', 'content'),
2223 $asset, $params, $mimeType, $content, self
::$_nullObject, self
::$_nullObject,
2224 'civicrm_buildAsset'
2229 * This hook fires whenever a record in a case changes.
2231 * @param \Civi\CCase\Analyzer $analyzer
2232 * A bundle of data about the case (such as the case and activity records).
2234 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
2235 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
2236 \Civi
::dispatcher()->dispatch('hook_civicrm_caseChange', $event);
2240 * Generate a default CRUD URL for an entity.
2242 * @param array $spec
2244 * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
2245 * - entity_table: string
2247 * @param CRM_Core_DAO $bao
2248 * @param array $link
2249 * To define the link, add these keys to $link:.
2253 * - url: string (used in lieu of "path"/"query")
2254 * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
2257 public static function crudLink($spec, $bao, &$link) {
2258 return self
::singleton()->invoke(array('spec', 'bao', 'link'), $spec, $bao, $link,
2259 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2265 * Modify the CiviCRM container - add new services, parameters, extensions, etc.
2268 * use Symfony\Component\Config\Resource\FileResource;
2269 * use Symfony\Component\DependencyInjection\Definition;
2271 * function mymodule_civicrm_container($container) {
2272 * $container->addResource(new FileResource(__FILE__));
2273 * $container->setDefinition('mysvc', new Definition('My\Class', array()));
2277 * Tip: The container configuration will be compiled/cached. The default cache
2278 * behavior is aggressive. When you first implement the hook, be sure to
2279 * flush the cache. Additionally, you should relax caching during development.
2280 * In `civicrm.settings.php`, set define('CIVICRM_CONTAINER_CACHE', 'auto').
2282 * Note: This is a preboot hook. It will dispatch via the extension/module
2283 * subsystem but *not* the Symfony EventDispatcher.
2285 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
2286 * @see http://symfony.com/doc/current/components/dependency_injection/index.html
2288 public static function container(\Symfony\Component\DependencyInjection\ContainerBuilder
$container) {
2289 self
::singleton()->invoke(array('container'), $container, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_container');
2293 * @param array <CRM_Core_FileSearchInterface> $fileSearches
2296 public static function fileSearches(&$fileSearches) {
2297 return self
::singleton()->invoke(array('fileSearches'), $fileSearches,
2298 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2299 'civicrm_fileSearches'
2304 * Check system status.
2306 * @param array $messages
2307 * Array<CRM_Utils_Check_Message>. A list of messages regarding system status.
2310 public static function check(&$messages) {
2311 return self
::singleton()
2312 ->invoke(array('messages'), $messages, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_check');
2316 * This hook is called when a query string of the CSV Batch export is generated.
2318 * @param string $query
2322 public static function batchQuery(&$query) {
2323 return self
::singleton()->invoke(array('query'), $query, self
::$_nullObject,
2324 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2325 'civicrm_batchQuery'
2330 * This hook is called to alter Deferred revenue item values just before they are
2331 * inserted in civicrm_financial_trxn table
2333 * @param array $deferredRevenues
2335 * @param array $contributionDetails
2337 * @param bool $update
2339 * @param string $context
2343 public static function alterDeferredRevenueItems(&$deferredRevenues, $contributionDetails, $update, $context) {
2344 return self
::singleton()->invoke(array('deferredRevenues', 'contributionDetails', 'update', 'context'), $deferredRevenues, $contributionDetails, $update, $context,
2345 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterDeferredRevenueItems'
2350 * This hook is called when the entries of the CSV Batch export are mapped.
2352 * @param array $results
2353 * @param array $items
2357 public static function batchItems(&$results, &$items) {
2358 return self
::singleton()->invoke(array('results', 'items'), $results, $items,
2359 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2360 'civicrm_batchItems'
2365 * This hook is called when core resources are being loaded
2367 * @see CRM_Core_Resources::coreResourceList
2369 * @param array $list
2370 * @param string $region
2372 public static function coreResourceList(&$list, $region) {
2373 // First allow the cms integration to add to the list
2374 CRM_Core_Config
::singleton()->userSystem
->appendCoreResources($list);
2376 self
::singleton()->invoke(array('list', 'region'), $list, $region,
2377 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2378 'civicrm_coreResourceList'
2383 * Allows the list of filters on the EntityRef widget to be altered.
2385 * @see CRM_Core_Resources::entityRefFilters
2387 * @param array $filters
2389 public static function entityRefFilters(&$filters) {
2390 self
::singleton()->invoke(array('filters'), $filters, self
::$_nullObject, self
::$_nullObject,
2391 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2392 'civicrm_entityRefFilters'
2397 * This hook is called for bypass a few civicrm urls from IDS check.
2399 * @param array $skip list of civicrm urls
2403 public static function idsException(&$skip) {
2404 return self
::singleton()->invoke(array('skip'), $skip, self
::$_nullObject,
2405 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2406 'civicrm_idsException'
2411 * This hook is called when a geocoder's format method is called.
2413 * @param string $geoProvider
2414 * @param array $values
2415 * @param SimpleXMLElement $xml
2419 public static function geocoderFormat($geoProvider, &$values, $xml) {
2420 return self
::singleton()->invoke(array('geoProvider', 'values', 'xml'), $geoProvider, $values, $xml,
2421 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2422 'civicrm_geocoderFormat'
2427 * This hook is called before an inbound SMS is processed.
2429 * @param CRM_SMS_Message Object $message
2430 * An SMS message recieved
2433 public static function inboundSMS(&$message) {
2434 return self
::singleton()->invoke(array('message'), $message, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_inboundSMS');
2438 * This hook is called to modify api params of EntityRef form field
2440 * @param array $params
2444 public static function alterEntityRefParams(&$params, $formName) {
2445 return self
::singleton()->invoke(array('params', 'formName'), $params, $formName,
2446 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2447 'civicrm_alterEntityRefParams'
2452 * This hook is called before a scheduled job is executed
2454 * @param CRM_Core_DAO_Job $job
2455 * The job to be executed
2456 * @param array $params
2457 * The arguments to be given to the job
2459 public static function preJob($job, $params) {
2460 return self
::singleton()->invoke(array('job', 'params'), $job, $params,
2461 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2467 * This hook is called after a scheduled job is executed
2469 * @param CRM_Core_DAO_Job $job
2470 * The job that was executed
2471 * @param array $params
2472 * The arguments given to the job
2473 * @param array $result
2474 * The result of the API call, or the thrown exception if any
2476 public static function postJob($job, $params, $result) {
2477 return self
::singleton()->invoke(array('job', 'params', 'result'), $job, $params, $result,
2478 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2484 * This hook is called before and after constructing mail recipients.
2485 * Allows user to alter filter and/or search query to fetch mail recipients
2487 * @param CRM_Mailing_DAO_Mailing $mailingObject
2488 * @param array $criteria
2489 * A list of SQL criteria; you can add/remove/replace/modify criteria.
2490 * Array(string $name => CRM_Utils_SQL_Select $criterion).
2491 * Ex: array('do_not_email' => CRM_Utils_SQL_Select::fragment()->where("$contact.do_not_email = 0")).
2492 * @param string $context
2496 public static function alterMailingRecipients(&$mailingObject, &$criteria, $context) {
2497 return self
::singleton()->invoke(array('mailingObject', 'params', 'context'),
2498 $mailingObject, $criteria, $context,
2499 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2500 'civicrm_alterMailingRecipients'
2505 * ALlow Extensions to custom process IPN hook data such as sending Google Analyitcs information based on the IPN
2506 * @param array $IPNData - Array of IPN Data
2509 public static function postIPNProcess(&$IPNData) {
2510 return self
::singleton()->invoke(array('IPNData'),
2511 $IPNData, self
::$_nullObject, self
::$_nullObject,
2512 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2513 'civicrm_postIPNProcess'