3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
14 * @package CiviCRM_Hook
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 abstract class CRM_Utils_Hook
{
19 // Allowed values for dashboard hook content placement
20 // Default - place content below activity list
21 const DASHBOARD_BELOW
= 1;
22 // Place content above activity list
23 const DASHBOARD_ABOVE
= 2;
24 // Don't display activity list at all
25 const DASHBOARD_REPLACE
= 3;
27 // by default - place content below existing content
28 const SUMMARY_BELOW
= 1;
29 // place hook content above
30 const SUMMARY_ABOVE
= 2;
32 *create your own summaries
34 const SUMMARY_REPLACE
= 3;
37 * Object to pass when an object is required to be passed by params.
39 * This is supposed to be a convenience but note that it is a bad
40 * pattern as it can get contaminated & result in hard-to-diagnose bugs.
44 public static $_nullObject = NULL;
47 * We only need one instance of this object. So we use the singleton
48 * pattern and cache the instance in this variable
52 static private $_singleton = NULL;
57 private $commonIncluded = FALSE;
62 private $commonCiviModules = [];
65 * @var CRM_Utils_Cache_Interface
70 * Constructor and getter for the singleton instance.
74 * @return CRM_Utils_Hook
75 * An instance of $config->userHookClass
77 public static function singleton($fresh = FALSE) {
78 if (self
::$_singleton == NULL ||
$fresh) {
79 $config = CRM_Core_Config
::singleton();
80 $class = $config->userHookClass
;
81 self
::$_singleton = new $class();
83 return self
::$_singleton;
87 * CRM_Utils_Hook constructor.
89 * @throws \CRM_Core_Exception
91 public function __construct() {
92 $this->cache
= CRM_Utils_Cache
::create([
94 'type' => ['ArrayCache'],
100 * Invoke a hook through the UF/CMS hook system and the extension-hook
103 * @param int $numParams
104 * Number of parameters to pass to the hook.
106 * Parameter to be passed to the hook.
108 * Parameter to be passed 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.
117 * @param string $fnSuffix
118 * Function suffix, this is effectively the hook name.
122 abstract public function invokeViaUF(
124 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
131 * This is a transitional adapter. It supports the legacy syntax
132 * but also accepts enough information to support Symfony Event
135 * @param array $names
136 * (Recommended) Array of parameter names, in order.
137 * Using an array is recommended because it enables full
138 * event-broadcasting behaviors.
139 * (Legacy) Number of parameters to pass to the hook.
140 * This is provided for transitional purposes.
147 * @param mixed $fnSuffix
150 public function invoke(
152 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
155 if (!is_array($names)) {
156 // We were called with the old contract wherein $names is actually an int.
157 // Symfony dispatcher requires some kind of name.
158 CRM_Core_Error
::deprecatedWarning("hook_$fnSuffix should be updated to pass an array of parameter names to CRM_Utils_Hook::invoke().");
159 $compatNames = ['arg1', 'arg2', 'arg3', 'arg4', 'arg5', 'arg6'];
160 $names = array_slice($compatNames, 0, (int) $names);
163 $event = \Civi\Core\Event\GenericHookEvent
::createOrdered(
165 [&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6]
167 \Civi
::dispatcher()->dispatch('hook_' . $fnSuffix, $event);
168 return $event->getReturnValues();
172 * @param array $numParams
184 public function commonInvoke(
186 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
190 $this->commonBuildModuleList($fnPrefix);
192 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
193 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
198 * Build the list of modules to be processed for hooks.
200 * @param string $fnPrefix
202 public function commonBuildModuleList($fnPrefix) {
203 if (!$this->commonIncluded
) {
204 // include external file
205 $this->commonIncluded
= TRUE;
207 $config = CRM_Core_Config
::singleton();
208 if (!empty($config->customPHPPathDir
)) {
209 $civicrmHooksFile = CRM_Utils_File
::addTrailingSlash($config->customPHPPathDir
) . 'civicrmHooks.php';
210 if (file_exists($civicrmHooksFile)) {
211 @include_once
$civicrmHooksFile;
215 if (!empty($fnPrefix)) {
216 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
219 $this->requireCiviModules($this->commonCiviModules
);
226 * @param array $civiModules
227 * @param string $fnSuffix
228 * @param int $numParams
237 * @throws \CRM_Core_Exception
239 public function runHooks(
240 $civiModules, $fnSuffix, $numParams,
241 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
243 // $civiModules is *not* passed by reference because runHooks
244 // must be reentrant. PHP is finicky about running
245 // multiple loops over the same variable. The circumstances
246 // to reproduce the issue are pretty intricate.
249 $fnNames = $this->cache
->get($fnSuffix);
250 if (!is_array($fnNames)) {
252 if ($civiModules !== NULL) {
253 foreach ($civiModules as $module) {
254 $fnName = "{$module}_{$fnSuffix}";
255 if (function_exists($fnName)) {
256 $fnNames[] = $fnName;
259 $this->cache
->set($fnSuffix, $fnNames);
263 foreach ($fnNames as $fnName) {
265 switch ($numParams) {
267 $fResult = $fnName();
271 $fResult = $fnName($arg1);
275 $fResult = $fnName($arg1, $arg2);
279 $fResult = $fnName($arg1, $arg2, $arg3);
283 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
287 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
291 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
295 throw new CRM_Core_Exception(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 [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.
334 * @param int|null $id
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 is equivalent to post(), except that it is guaranteed to run
372 * outside of any SQL transaction. The objectRef is not modifiable.
374 * This hook is defined for two cases:
376 * 1. If the original action runs within a transaction, then the hook fires
377 * after the transaction commits.
378 * 2. If the original action runs outside a transaction, then the data was
379 * committed immediately, and we can run the hook immediately.
382 * The type of operation being performed.
383 * @param string $objectName
384 * The name of the object.
385 * @param int $objectId
386 * The unique identifier for the object.
387 * @param object $objectRef
388 * The reference to the object if available.
391 * based on op. pre-hooks return a boolean or
392 * an error message which aborts the operation
394 public static function postCommit($op, $objectName, $objectId, $objectRef = NULL) {
395 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
396 \Civi
::dispatcher()->dispatch('hook_civicrm_postCommit', $event);
397 return $event->getReturnValues();
401 * This hook retrieves links from other modules and injects it into.
402 * the view contact tabs
405 * The type of operation being performed.
406 * @param string $objectName
407 * The name of the object.
408 * @param int $objectId
409 * The unique identifier for the object.
410 * @param array $links
411 * (optional) the links array (introduced in v3.2).
413 * (optional) the bitmask to show/hide links.
414 * @param array $values
415 * (optional) the values to fill the links.
418 * the return value is ignored
420 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = []) {
421 return self
::singleton()->invoke(['op', 'objectName', 'objectId', 'links', 'mask', 'values'], $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
425 * Alter the contents of a resource bundle (ie a collection of JS/CSS/etc).
427 * TIP: $bundle->add*() and $bundle->filter() should be useful for
428 * adding/removing/updating items.
430 * @param CRM_Core_Resources_Bundle $bundle
432 * @see CRM_Core_Resources_CollectionInterface::add()
433 * @see CRM_Core_Resources_CollectionInterface::filter()
435 public static function alterBundle($bundle) {
436 return self
::singleton()
437 ->invoke(['bundle'], $bundle, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBundle');
441 * This hook is invoked during the CiviCRM form preProcess phase.
443 * @param string $formName
444 * The name of the form.
445 * @param CRM_Core_Form $form
446 * Reference to the form object.
449 * the return value is ignored
451 public static function preProcess($formName, &$form) {
452 return self
::singleton()
453 ->invoke(['formName', 'form'], $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
457 * This hook is invoked when building a CiviCRM form. This hook should also
458 * be used to set the default values of a form element
460 * @param string $formName
461 * The name of the form.
462 * @param CRM_Core_Form $form
463 * Reference to the form object.
466 * the return value is ignored
468 public static function buildForm($formName, &$form) {
469 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
470 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
476 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
477 * any form elements, this hook should save the values in the database
479 * @param string $formName
480 * The name of the form.
481 * @param CRM_Core_Form $form
482 * Reference to the form object.
485 * the return value is ignored
487 public static function postProcess($formName, &$form) {
488 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
489 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
490 'civicrm_postProcess'
495 * This hook is invoked during all CiviCRM form validation. An array of errors
496 * detected is returned. Else we assume validation succeeded.
498 * @param string $formName
499 * The name of the form.
500 * @param array &$fields the POST parameters as filtered by QF
501 * @param array &$files the FILES parameters as sent in by POST
502 * @param array &$form the form object
503 * @param array &$errors the array of errors.
506 * formRule hooks return a boolean or
507 * an array of error messages which display a QF Error
509 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
510 return self
::singleton()
511 ->invoke(['formName', 'fields', 'files', 'form', 'errors'],
512 $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
516 * This hook is called after a db write on a custom table.
519 * The type of operation being performed.
520 * @param int $groupID
521 * The custom group ID.
522 * @param int $entityID
523 * The entityID of the row in the custom table.
524 * @param array $params
525 * The parameters that were sent into the calling function.
528 * the return value is ignored
530 public static function custom(string $op, int $groupID, int $entityID, &$params) {
531 return self
::singleton()
532 ->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
536 * This hook is called before a db write on a custom table.
539 * The type of operation being performed.
540 * @param int $groupID
541 * The custom group ID.
542 * @param int $entityID
543 * The entityID of the row in the custom table.
544 * @param array $params
545 * The parameters that were sent into the calling function.
548 * the return value is ignored
550 public static function customPre(string $op, int $groupID, int $entityID, array &$params) {
551 return self
::singleton()
552 ->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_customPre');
556 * This hook is called when composing the ACL where clause to restrict
557 * visibility of contacts to the logged in user
560 * The type of permission needed.
561 * @param array $tables
562 * (reference ) add the tables that are needed for the select clause.
563 * @param array $whereTables
564 * (reference ) add the tables that are needed for the where clause.
565 * @param int $contactID
566 * The contactID for whom the check is made.
567 * @param string $where
568 * The currrent where clause.
571 * the return value is ignored
573 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
574 return self
::singleton()
575 ->invoke(['type', 'tables', 'whereTables', 'contactID', 'where'], $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
579 * This hook is called when composing the ACL where clause to restrict
580 * visibility of contacts to the logged in user
583 * The type of permission needed.
584 * @param int $contactID
585 * The contactID for whom the check is made.
586 * @param string $tableName
587 * The tableName which is being permissioned.
588 * @param array $allGroups
589 * The set of all the objects for the above table.
590 * @param array $currentGroups
591 * The set of objects that are currently permissioned for this contact.
594 * the return value is ignored
596 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
597 return self
::singleton()
598 ->invoke(['type', 'contactID', 'tableName', 'allGroups', 'currentGroups'], $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
602 * @param string|CRM_Core_DAO $entity
603 * @param array $clauses
606 public static function selectWhereClause($entity, &$clauses) {
607 $entityName = is_object($entity) ?
_civicrm_api_get_entity_name_from_dao($entity) : $entity;
608 return self
::singleton()->invoke(['entity', 'clauses'], $entityName, $clauses,
609 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
610 'civicrm_selectWhereClause'
615 * This hook is called when building the menu table.
617 * @param array $files
618 * The current set of files to process.
621 * the return value is ignored
623 public static function xmlMenu(&$files) {
624 return self
::singleton()->invoke(['files'], $files,
625 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
631 * (Experimental) This hook is called when build the menu table.
633 * @param array $items
634 * List of records to include in menu table.
636 * the return value is ignored
638 public static function alterMenu(&$items) {
639 return self
::singleton()->invoke(['items'], $items,
640 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
646 * A theme is a set of CSS files which are loaded on CiviCRM pages. To register a new
647 * theme, add it to the $themes array. Use these properties:
649 * - ext: string (required)
650 * The full name of the extension which defines the theme.
651 * Ex: "org.civicrm.themes.greenwich".
652 * - title: string (required)
654 * - help: string (optional)
655 * Description of the theme's appearance.
656 * - url_callback: mixed (optional)
657 * A function ($themes, $themeKey, $cssExt, $cssFile) which returns the URL(s) for a CSS resource.
658 * Returns either an array of URLs or PASSTHRU.
659 * Ex: \Civi\Core\Themes\Resolvers::simple (default)
660 * Ex: \Civi\Core\Themes\Resolvers::none
661 * - prefix: string (optional)
662 * A prefix within the extension folder to prepend to the file name.
663 * - search_order: array (optional)
664 * A list of themes to search.
665 * Generally, the last theme should be "*fallback*" (Civi\Core\Themes::FALLBACK).
666 * - excludes: array (optional)
667 * A list of files (eg "civicrm:css/bootstrap.css" or "$ext:$file") which should never
668 * be returned (they are excluded from display).
670 * @param array $themes
671 * List of themes, keyed by name.
673 * the return value is ignored
675 public static function themes(&$themes) {
676 return self
::singleton()->invoke(['themes'], $themes,
677 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
683 * The activeTheme hook determines which theme is active.
685 * @param string $theme
686 * The identifier for the theme. Alterable.
688 * @param array $context
689 * Information about the current page-request. Includes some mix of:
690 * - page: the relative path of the current Civi page (Ex: 'civicrm/dashboard').
691 * - themes: an instance of the Civi\Core\Themes service.
693 * the return value is ignored
695 public static function activeTheme(&$theme, $context) {
696 return self
::singleton()->invoke(['theme', 'context'], $theme, $context,
697 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
698 'civicrm_activeTheme'
703 * This hook is called for declaring managed entities via API.
706 * // Example: Optimal skeleton for backward/forward compatibility
707 * function example_civicrm_managed(&$entities, ?array $modules = NULL) {
708 * if ($modules !== NULL && !in_array(E::LONG_NAME, $modules, TRUE)) {
712 * 'module' => E::LONG_NAME,
713 * 'name' => 'my_option_value',
714 * 'entity' => 'OptionValue',
720 * @param array $entities
721 * List of pending entities. Each entity is an array with keys:
722 * + '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")
723 * + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
724 * + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
725 * + 'params': array, the entity data as supported by the CiviCRM API
726 * + 'update' (v4.5+): string, a policy which describes when to update records
727 * - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
728 * - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
729 * + '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)
730 * - 'always' (default): always delete orphaned records
731 * - 'never': never delete orphaned records
732 * - '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.)
733 * @param array|NULL $modules
734 * (Added circa v5.50) If given, only report entities related to $modules. NULL is a wildcard ("all modules").
736 * This parameter is _advisory_ and is not supplied on older versions.
737 * Listeners SHOULD self-censor (only report entities which match the filter).
738 * However, all pre-existing listeners were unaware of this option, and they WILL over-report.
739 * Over-reported data will be discarded.
741 * the return value is ignored
743 public static function managed(&$entities, ?
array $modules = NULL) {
744 self
::singleton()->invoke(['entities', 'modules'], $entities, $modules,
745 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
749 $entities = array_filter($entities, function($entity) use ($modules) {
750 return in_array($entity['module'], $modules, TRUE);
756 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
758 * @param int $contactID
759 * The contactID for whom the dashboard is being rendered.
760 * @param int $contentPlacement
761 * (output parameter) where should the hook content be displayed.
762 * relative to the activity list
765 * the html snippet to include in the dashboard
767 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
768 $retval = self
::singleton()->invoke(['contactID', 'contentPlacement'], $contactID, $contentPlacement,
769 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
774 * Note we need this seemingly unnecessary code because in the event that the implementation
775 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
776 * though we have a default value in this function's declaration above.
778 if (!isset($contentPlacement)) {
779 $contentPlacement = self
::DASHBOARD_BELOW
;
786 * This hook is called before storing recently viewed items.
788 * @param array $recentArray
789 * An array of recently viewed or processed items, for in place modification.
793 public static function recent(&$recentArray) {
794 return self
::singleton()->invoke(['recentArray'], $recentArray,
795 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
801 * Determine how many other records refer to a given record.
803 * @param CRM_Core_DAO $dao
804 * The item for which we want a reference count.
805 * @param array $refCounts
806 * Each item in the array is an Array with keys:
807 * - name: string, eg "sql:civicrm_email:contact_id"
808 * - type: string, eg "sql"
809 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
812 * Return is not really intended to be used.
814 public static function referenceCounts($dao, &$refCounts) {
815 return self
::singleton()->invoke(['dao', 'refCounts'], $dao, $refCounts,
816 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
817 'civicrm_referenceCounts'
822 * This hook is called when building the amount structure for a Contribution or Event Page.
824 * @param int $pageType
825 * Is this a contribution or event page.
826 * @param CRM_Core_Form $form
827 * Reference to the form object.
828 * @param array $amount
829 * The amount structure to be displayed.
833 public static function buildAmount($pageType, &$form, &$amount) {
834 return self
::singleton()->invoke(['pageType', 'form', 'amount'], $pageType, $form, $amount, self
::$_nullObject,
835 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
839 * This hook is called when building the state list for a particular country.
841 * @param array $countryID
842 * The country id whose states are being selected.
847 public static function buildStateProvinceForCountry($countryID, &$states) {
848 return self
::singleton()->invoke(['countryID', 'states'], $countryID, $states,
849 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
850 'civicrm_buildStateProvinceForCountry'
855 * This hook is called when rendering the tabs used for events and potentially
856 * contribution pages, etc.
858 * @param string $tabsetName
859 * Name of the screen or visual element.
861 * Tabs that will be displayed.
862 * @param array $context
863 * Extra data about the screen or context in which the tab is used.
867 public static function tabset($tabsetName, &$tabs, $context) {
868 return self
::singleton()->invoke(['tabsetName', 'tabs', 'context'], $tabsetName, $tabs,
869 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
874 * This hook is called when sending an email / printing labels
876 * @param array $tokens
877 * The list of tokens that can be used for the contact.
881 public static function tokens(&$tokens) {
882 return self
::singleton()->invoke(['tokens'], $tokens,
883 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
888 * This hook allows modification of the admin panels
890 * @param array $panels
891 * Associated array of admin panels
895 public static function alterAdminPanel(&$panels) {
896 return self
::singleton()->invoke(['panels'], $panels,
897 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
898 'civicrm_alterAdminPanel'
903 * This hook is called when sending an email / printing labels to get the values for all the
904 * tokens returned by the 'tokens' hook
906 * @param array $details
907 * The array to store the token values indexed by contactIDs.
908 * @param array $contactIDs
909 * An array of contactIDs.
911 * The jobID if this is associated with a CiviMail mailing.
912 * @param array $tokens
913 * The list of tokens associated with the content.
914 * @param string $className
915 * The top level className from where the hook is invoked.
919 public static function tokenValues(
926 return self
::singleton()
927 ->invoke(['details', 'contactIDs', 'jobID', 'tokens', 'className'], $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
931 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
934 * @param object $page
935 * The page that will be rendered.
939 public static function pageRun(&$page) {
940 return self
::singleton()->invoke(['page'], $page,
941 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
947 * This hook is called after a copy of an object has been made. The current objects are
948 * Event, Contribution Page and UFGroup
950 * @param string $objectName
951 * Name of the object.
952 * @param object $object
953 * Reference to the copy.
957 public static function copy($objectName, &$object) {
958 return self
::singleton()->invoke(['objectName', 'object'], $objectName, $object,
959 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
965 * This hook is called when a contact unsubscribes from a mailing. It allows modules
966 * to override what the contacts are removed from.
970 * @param int $mailingId
971 * The id of the mailing to unsub from
972 * @param int $contactId
973 * The id of the contact who is unsubscribing
974 * @param array|int $groups
975 * Groups the contact will be removed from.
976 * @param array|int $baseGroups
977 * Base groups (used in smart mailings) the contact will be removed from.
982 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
983 return self
::singleton()
984 ->invoke(['op', 'mailingId', 'contactId', 'groups', 'baseGroups'], $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
988 * This hook is called when CiviCRM needs to edit/display a custom field with options
990 * @deprecated in favor of hook_civicrm_fieldOptions
992 * @param int $customFieldID
993 * The custom field ID.
994 * @param array $options
995 * The current set of options for that custom field.
996 * You can add/remove existing options.
997 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
998 * to be careful to not overwrite the array.
999 * Only add/edit/remove the specific field options you intend to affect.
1000 * @param bool $detailedFormat
1001 * If true, the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
1002 * @param array $selectAttributes
1003 * Contain select attribute(s) if any.
1007 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = []) {
1008 // Weird: $selectAttributes is inputted but not outputted.
1009 return self
::singleton()->invoke(['customFieldID', 'options', 'detailedFormat'], $customFieldID, $options, $detailedFormat,
1010 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1011 'civicrm_customFieldOptions'
1016 * Hook for modifying field options
1018 * @param string $entity
1019 * @param string $field
1020 * @param array $options
1021 * @param array $params
1025 public static function fieldOptions($entity, $field, &$options, $params) {
1026 return self
::singleton()->invoke(['entity', 'field', 'options', 'params'], $entity, $field, $options, $params,
1027 self
::$_nullObject, self
::$_nullObject,
1028 'civicrm_fieldOptions'
1034 * This hook is called to display the list of actions allowed after doing a search.
1035 * This allows the module developer to inject additional actions or to remove existing actions.
1037 * @param string $objectType
1038 * The object type for this search.
1039 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
1040 * @param array $tasks
1041 * The current set of tasks for that custom field.
1042 * You can add/remove existing tasks.
1043 * Each task needs to have a title (eg 'title' => ts( 'Group - add contacts')) and a class
1044 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
1045 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
1046 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
1047 * found in CRM/$objectType/Task.php.
1051 public static function searchTasks($objectType, &$tasks) {
1052 return self
::singleton()->invoke(['objectType', 'tasks'], $objectType, $tasks,
1053 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1054 'civicrm_searchTasks'
1059 * @param mixed $form
1060 * @param array $params
1064 public static function eventDiscount(&$form, &$params) {
1065 return self
::singleton()->invoke(['form', 'params'], $form, $params,
1066 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1067 'civicrm_eventDiscount'
1072 * When adding a new "Mail Account" (`MailSettings`), present a menu of setup
1075 * @param array $setupActions
1076 * Each item has a symbolic-key, and it has the properties:
1078 * - callback: string|array, the function which starts the setup process.
1079 * The function is expected to return a 'url' for the config screen.
1082 public static function mailSetupActions(&$setupActions) {
1083 return self
::singleton()->invoke(['setupActions'], $setupActions, self
::$_nullObject, self
::$_nullObject,
1084 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1085 'civicrm_mailSetupActions'
1090 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
1092 * @param mixed $form
1093 * The form object for which groups / mailings being displayed
1094 * @param array $groups
1095 * The list of groups being included / excluded
1096 * @param array $mailings
1097 * The list of mailings being included / excluded
1101 public static function mailingGroups(&$form, &$groups, &$mailings) {
1102 return self
::singleton()->invoke(['form', 'groups', 'mailings'], $form, $groups, $mailings,
1103 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1104 'civicrm_mailingGroups'
1109 * (Experimental) Modify the list of template-types used for CiviMail composition.
1111 * @param array $types
1112 * Sequentially indexed list of template types. Each type specifies:
1114 * - editorUrl: string, Angular template URL
1115 * - weight: int, priority when picking a default value for new mailings
1118 public static function mailingTemplateTypes(&$types) {
1119 return self
::singleton()->invoke(['types'], $types, self
::$_nullObject, self
::$_nullObject,
1120 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1121 'civicrm_mailingTemplateTypes'
1126 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
1128 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
1129 * You can use it to alter the membership types when first loaded, or after submission
1130 * (for example if you want to gather data in the form and use it to alter the fees).
1132 * @param mixed $form
1133 * The form object that is presenting the page
1134 * @param array $membershipTypes
1135 * The array of membership types and their amount
1139 public static function membershipTypeValues(&$form, &$membershipTypes) {
1140 return self
::singleton()->invoke(['form', 'membershipTypes'], $form, $membershipTypes,
1141 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1142 'civicrm_membershipTypeValues'
1147 * This hook is called when rendering the contact summary.
1149 * @param int $contactID
1150 * The contactID for whom the summary is being rendered
1151 * @param mixed $content
1152 * @param int $contentPlacement
1153 * Specifies where the hook content should be displayed relative to the
1157 * The html snippet to include in the contact summary
1159 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
1160 return self
::singleton()->invoke(['contactID', 'content', 'contentPlacement'], $contactID, $content, $contentPlacement,
1161 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1167 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
1168 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
1169 * If you want to limit the contacts returned to a specific group, or some other criteria
1170 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
1171 * The hook is called when the query is executed to get the list of contacts to display.
1173 * @param mixed $query
1174 * - the query that will be executed (input and output parameter);.
1175 * It's important to realize that the ACL clause is built prior to this hook being fired,
1176 * so your query will ignore any ACL rules that may be defined.
1177 * Your query must return two columns:
1178 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
1180 * @param string $queryText
1181 * The name string to execute the query against (this is the value being typed in by the user).
1182 * @param string $context
1183 * The context in which this ajax call is being made (for example: 'customfield', 'caseview').
1185 * The id of the object for which the call is being made.
1186 * For custom fields, it will be the custom field id
1190 public static function contactListQuery(&$query, $queryText, $context, $id) {
1191 return self
::singleton()->invoke(['query', 'queryText', 'context', 'id'], $query, $queryText, $context, $id,
1192 self
::$_nullObject, self
::$_nullObject,
1193 'civicrm_contactListQuery'
1198 * Hook definition for altering payment parameters before talking to a payment processor back end.
1200 * Definition will look like this:
1202 * function hook_civicrm_alterPaymentProcessorParams(
1208 * @param CRM_Core_Payment $paymentObj
1209 * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
1210 * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
1211 * @param array|\Civi\Payment\PropertyBag &$rawParams
1212 * array of params as passed to to the processor
1213 * @param array|\Civi\Payment\PropertyBag &$cookedParams
1214 * params after the processor code has translated them into its own key/value pairs
1217 * This return is not really intended to be used.
1219 public static function alterPaymentProcessorParams(
1224 return self
::singleton()->invoke(['paymentObj', 'rawParams', 'cookedParams'], $paymentObj, $rawParams, $cookedParams,
1225 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1226 'civicrm_alterPaymentProcessorParams'
1231 * This hook is called when an email is about to be sent by CiviCRM.
1233 * @param array $params
1234 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
1235 * returnPath, replyTo, headers, attachments (array)
1236 * @param string $context
1237 * The context in which the hook is being invoked, eg 'civimail'.
1241 public static function alterMailParams(&$params, $context = NULL) {
1242 return self
::singleton()->invoke(['params', 'context'], $params, $context,
1243 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1244 'civicrm_alterMailParams'
1249 * This hook is called when loading a mail-store (e.g. IMAP, POP3, or Maildir).
1251 * @param array $params
1252 * Most fields correspond to data in the MailSettings entity:
1255 * - username: string
1256 * - password: string
1259 * - local_part: string
1261 * With a few supplements
1262 * - protocol: string, symbolic protocol name (e.g. "IMAP")
1263 * - factory: callable, the function which instantiates the driver class
1264 * - auth: string, (for some drivers) specify the authentication method (eg "Password" or "XOAuth2")
1268 public static function alterMailStore(&$params) {
1269 return self
::singleton()->invoke(['params'], $params, $context,
1270 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1271 'civicrm_alterMailStore'
1276 * This hook is called when membership status is being calculated.
1278 * @param array $membershipStatus
1279 * Membership status details as determined - alter if required.
1280 * @param array $arguments
1281 * Arguments passed in to calculate date.
1286 * - 'exclude_is_admin'
1287 * - 'membership_type_id'
1288 * @param array $membership
1289 * Membership details from the calling function.
1293 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
1294 return self
::singleton()->invoke(['membershipStatus', 'arguments', 'membership'], $membershipStatus, $arguments,
1295 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1296 'civicrm_alterCalculatedMembershipStatus'
1301 * This hook is called after getting the content of the mail and before tokenizing it.
1303 * @param array $content
1304 * Array fields include: html, text, subject
1308 public static function alterMailContent(&$content) {
1309 return self
::singleton()->invoke(['content'], $content,
1310 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1311 'civicrm_alterMailContent'
1316 * This hook is called when rendering the Manage Case screen.
1318 * @param int $caseID
1322 * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
1323 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
1325 public static function caseSummary($caseID) {
1326 return self
::singleton()->invoke(['caseID'], $caseID,
1327 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1328 'civicrm_caseSummary'
1333 * This hook is called when locating CiviCase types.
1335 * @param array $caseTypes
1339 public static function caseTypes(&$caseTypes) {
1340 return self
::singleton()
1341 ->invoke(['caseTypes'], $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
1345 * This hook is called when getting case email subject patterns.
1347 * All emails related to cases have case hash/id in the subject, e.g:
1348 * [case #ab12efg] Magic moment
1349 * [case #1234] Magic is here
1351 * Using this hook you can replace/enrich default list with some other
1352 * patterns, e.g. include case type categories (see CiviCase extension) like:
1353 * [(case|project|policy initiative) #hash]
1354 * [(case|project|policy initiative) #id]
1356 * @param array $subjectPatterns
1357 * Cases related email subject regexp patterns.
1361 public static function caseEmailSubjectPatterns(&$subjectPatterns) {
1362 return self
::singleton()
1363 ->invoke(['caseEmailSubjectPatterns'], $subjectPatterns, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseEmailSubjectPatterns');
1367 * This hook is called soon after the CRM_Core_Config object has ben initialized.
1368 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1370 * @param CRM_Core_Config|array $config
1375 public static function config(&$config) {
1376 return self
::singleton()->invoke(['config'], $config,
1377 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1383 * This hooks allows to change option values.
1385 * @deprecated in favor of hook_civicrm_fieldOptions
1387 * @param array $options
1388 * Associated array of option values / id
1389 * @param string $groupName
1394 public static function optionValues(&$options, $groupName) {
1395 return self
::singleton()->invoke(['options', 'groupName'], $options, $groupName,
1396 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1397 'civicrm_optionValues'
1402 * This hook allows modification of the navigation menu.
1404 * @param array $params
1405 * Associated array of navigation menu entry to Modify/Add
1409 public static function navigationMenu(&$params) {
1410 return self
::singleton()->invoke(['params'], $params,
1411 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1412 'civicrm_navigationMenu'
1417 * This hook allows modification of the data used to perform merging of duplicates.
1419 * @param string $type
1420 * The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1421 * @param array $data
1422 * The data, as described in $type.
1423 * @param int $mainId
1424 * Contact_id of the contact that survives the merge.
1425 * @param int $otherId
1426 * Contact_id of the contact that will be absorbed and deleted.
1427 * @param array $tables
1428 * When $type is "sqls", an array of tables as it may have been handed to the calling function.
1432 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1433 return self
::singleton()->invoke(['type', 'data', 'mainId', 'otherId', 'tables'], $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
1437 * This hook allows modification of the data calculated for merging locations.
1439 * @param array $blocksDAO
1440 * Array of location DAO to be saved. These are arrays in 2 keys 'update' & 'delete'.
1441 * @param int $mainId
1442 * Contact_id of the contact that survives the merge.
1443 * @param int $otherId
1444 * Contact_id of the contact that will be absorbed and deleted.
1445 * @param array $migrationInfo
1446 * Calculated migration info, informational only.
1450 public static function alterLocationMergeData(&$blocksDAO, $mainId, $otherId, $migrationInfo) {
1451 return self
::singleton()->invoke(['blocksDAO', 'mainId', 'otherId', 'migrationInfo'], $blocksDAO, $mainId, $otherId, $migrationInfo, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterLocationMergeData');
1455 * This hook provides a way to override the default privacy behavior for notes.
1457 * @param array &$noteValues
1458 * Associative array of values for this note
1462 public static function notePrivacy(&$noteValues) {
1463 return self
::singleton()->invoke(['noteValues'], $noteValues,
1464 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1465 'civicrm_notePrivacy'
1470 * This hook is called before record is exported as CSV.
1472 * @param string $exportTempTable
1473 * Name of the temporary export table used during export.
1474 * @param array $headerRows
1475 * Header rows for output.
1476 * @param array $sqlColumns
1478 * @param int $exportMode
1479 * Export mode ( contact, contribution, etc...).
1480 * @param string $componentTable
1481 * Name of temporary table
1483 * Array of object's ids
1487 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, $exportMode, $componentTable, $ids) {
1488 return self
::singleton()->invoke(['exportTempTable', 'headerRows', 'sqlColumns', 'exportMode', 'componentTable', 'ids'],
1489 $exportTempTable, $headerRows, $sqlColumns,
1490 $exportMode, $componentTable, $ids,
1496 * This hook allows modification of the queries constructed from dupe rules.
1498 * @param string $obj
1499 * Object of rulegroup class.
1500 * @param string $type
1501 * Type of queries e.g table / threshold.
1502 * @param array $query
1507 public static function dupeQuery($obj, $type, &$query) {
1508 return self
::singleton()->invoke(['obj', 'type', 'query'], $obj, $type, $query,
1509 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1515 * Check for duplicate contacts
1517 * @param array $dedupeParams
1518 * Array of params for finding duplicates: [
1519 * '{parameters returned by CRM_Dedupe_Finder::formatParams}
1520 * 'check_permission' => TRUE/FALSE;
1521 * 'contact_type' => $contactType;
1523 * 'rule_group_id' => $ruleGroupID;
1524 * 'excludedContactIDs' => $excludedContactIDs;
1525 * @param array $dedupeResults
1526 * Array of results ['handled' => TRUE/FALSE, 'ids' => array of IDs of duplicate contacts]
1527 * @param array $contextParams
1528 * The context if relevant, eg. ['event_id' => X]
1532 public static function findDuplicates($dedupeParams, &$dedupeResults, $contextParams) {
1533 return self
::singleton()
1534 ->invoke(['dedupeParams', 'dedupeResults', 'contextParams'], $dedupeParams, $dedupeResults, $contextParams, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_findDuplicates');
1538 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1540 * @param string $type
1541 * Type of mail processed: 'activity' OR 'mailing'.
1542 * @param array &$params the params that were sent to the CiviCRM API function
1543 * @param object $mail
1544 * The mail object which is an ezcMail class.
1545 * @param array &$result the result returned by the api call
1546 * @param string $action
1547 * (optional ) the requested action to be performed if the types was 'mailing'.
1551 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1552 return self
::singleton()
1553 ->invoke(['type', 'params', 'mail', 'result', 'action'], $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1557 * This hook is called after a row has been processed and the
1558 * record (and associated records imported
1560 * @param string $object
1561 * Object being imported (for now Contact only, later Contribution, Activity,.
1562 * Participant and Member)
1563 * @param string $usage
1564 * Hook usage/location (for now process only, later mapping and others).
1565 * @param string $objectRef
1566 * Import record object.
1567 * @param array $params
1568 * Array with various key values: currently.
1569 * contactID - contact id
1570 * importID - row id in temp table
1571 * importTempTable - name of tempTable
1572 * fieldHeaders - field headers
1573 * fields - import fields
1577 public static function import($object, $usage, &$objectRef, &$params) {
1578 return self
::singleton()->invoke(['object', 'usage', 'objectRef', 'params'], $object, $usage, $objectRef, $params,
1579 self
::$_nullObject, self
::$_nullObject,
1585 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1586 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1588 * @param string $entity
1589 * The API entity (like contact).
1590 * @param string $action
1591 * The API action (like get).
1592 * @param array &$params the API parameters
1593 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1597 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1598 return self
::singleton()->invoke(['entity', 'action', 'params', 'permissions'], $entity, $action, $params, $permissions,
1599 self
::$_nullObject, self
::$_nullObject,
1600 'civicrm_alterAPIPermissions'
1605 * @param CRM_Core_DAO $dao
1609 public static function postSave(&$dao) {
1610 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1611 return self
::singleton()->invoke(['dao'], $dao,
1612 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1618 * This hook allows user to customize context menu Actions on contact summary page.
1620 * @param array $actions
1621 * Array of all Actions in contextmenu.
1622 * @param int $contactID
1623 * ContactID for the summary page.
1627 public static function summaryActions(&$actions, $contactID = NULL) {
1628 return self
::singleton()->invoke(['actions', 'contactID'], $actions, $contactID,
1629 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1630 'civicrm_summaryActions'
1635 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1636 * This enables us hook implementors to modify both the headers and the rows
1638 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1639 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1641 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1642 * you want displayed. This is a hackish, but avoids template modification.
1644 * @param string $objectName
1645 * The component name that we are doing the search.
1646 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1647 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1648 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1649 * @param array $selector
1650 * the selector object. Allows you access to the context of the search
1653 * modify the header and values object to pass the data you need
1655 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1656 return self
::singleton()->invoke(['objectName', 'headers', 'rows', 'selector'], $objectName, $headers, $rows, $selector,
1657 self
::$_nullObject, self
::$_nullObject,
1658 'civicrm_searchColumns'
1663 * This hook is called when uf groups are being built for a module.
1665 * @param string $moduleName
1667 * @param array $ufGroups
1668 * Array of ufgroups for a module.
1672 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1673 return self
::singleton()->invoke(['moduleName', 'ufGroups'], $moduleName, $ufGroups,
1674 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1675 'civicrm_buildUFGroupsForModule'
1680 * This hook is called when we are determining the contactID for a specific
1683 * @param string $email
1684 * The email address.
1685 * @param int $contactID
1686 * The contactID that matches this email address, IF it exists.
1687 * @param array $result
1688 * (reference) has two fields.
1689 * contactID - the new (or same) contactID
1690 * action - 3 possible values:
1691 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1692 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1693 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1697 public static function emailProcessorContact($email, $contactID, &$result) {
1698 return self
::singleton()->invoke(['email', 'contactID', 'result'], $email, $contactID, $result,
1699 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1700 'civicrm_emailProcessorContact'
1705 * Hook definition for altering the generation of Mailing Labels.
1707 * @param array $args
1708 * An array of the args in the order defined for the tcpdf multiCell api call.
1709 * with the variable names below converted into string keys (ie $w become 'w'
1710 * as the first key for $args)
1711 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1712 * float $h Cell minimum height. The cell extends automatically if needed.
1713 * string $txt String to print
1714 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1715 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1716 * a string containing some or all of the following characters (in any order):
1717 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1718 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1719 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1720 * (default value when $ishtml=false)</li></ul>
1721 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1722 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1723 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1724 * float $x x position in user units
1725 * float $y y position in user units
1726 * boolean $reseth if true reset the last cell height (default true).
1727 * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1728 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1729 * necessary</li><li>4 = forced character spacing</li></ul>
1730 * boolean $ishtml set to true if $txt is HTML content (default = false).
1731 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1732 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1733 * or 0 for disable this feature. This feature works only when $ishtml=false.
1737 public static function alterMailingLabelParams(&$args) {
1738 return self
::singleton()->invoke(['args'], $args,
1739 self
::$_nullObject, self
::$_nullObject,
1740 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1741 'civicrm_alterMailingLabelParams'
1746 * This hooks allows alteration of generated page content.
1749 * Previously generated content.
1751 * Context of content - page or form.
1753 * The file name of the tpl.
1755 * A reference to the page or form object.
1759 public static function alterContent(&$content, $context, $tplName, &$object) {
1760 return self
::singleton()->invoke(['content', 'context', 'tplName', 'object'], $content, $context, $tplName, $object,
1761 self
::$_nullObject, self
::$_nullObject,
1762 'civicrm_alterContent'
1767 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1768 * altercontent hook as the content has already been rendered through the tpl at that point
1771 * Previously generated content.
1773 * Reference to the form object.
1775 * Context of content - page or form.
1777 * Reference the file name of the tpl.
1781 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1782 return self
::singleton()->invoke(['formName', 'form', 'context', 'tplName'], $formName, $form, $context, $tplName,
1783 self
::$_nullObject, self
::$_nullObject,
1784 'civicrm_alterTemplateFile'
1789 * Register cryptographic resources, such as keys and cipher-suites.
1791 * Ex: $crypto->addSymmetricKey([
1792 * 'key' => hash_hkdf('sha256', 'abcd1234'),
1793 * 'suite' => 'aes-cbc-hs',
1796 * @param \Civi\Crypto\CryptoRegistry $crypto
1800 public static function crypto($crypto) {
1801 return self
::singleton()->invoke(['crypto'], $crypto, self
::$_nullObject,
1802 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1809 * This hook collects the trigger definition from all components.
1812 * @param string $tableName
1813 * (optional) the name of the table that we are interested in only.
1815 * @internal param \reference $triggerInfo to an array of trigger information
1816 * each element has 4 fields:
1817 * table - array of tableName
1818 * when - BEFORE or AFTER
1819 * event - array of eventName - INSERT OR UPDATE OR DELETE
1820 * sql - array of statements optionally terminated with a ;
1821 * a statement can use the tokes {tableName} and {eventName}
1822 * to do token replacement with the table / event. This allows
1823 * templatizing logging and other hooks
1826 public static function triggerInfo(&$info, $tableName = NULL) {
1827 return self
::singleton()->invoke(['info', 'tableName'], $info, $tableName,
1828 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1830 'civicrm_triggerInfo'
1835 * Define the list of fields supported in APIv4 data-translation.
1837 * @param array $fields
1838 * List of data fields to translate, organized by table and column.
1839 * Omitted/unlisted fields are not translated. Any listed field may be translated.
1840 * Values should be TRUE.
1841 * Ex: $fields['civicrm_event']['summary'] = TRUE
1844 public static function translateFields(&$fields) {
1845 return self
::singleton()->invoke(['fields'], $fields, self
::$_nullObject,
1846 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1848 'civicrm_translateFields'
1853 * This hook allows changes to the spec of which tables to log.
1855 * @param array $logTableSpec
1859 public static function alterLogTables(&$logTableSpec) {
1860 return self
::singleton()->invoke(['logTableSpec'], $logTableSpec, $_nullObject,
1861 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1863 'civicrm_alterLogTables'
1868 * This hook is called when a module-extension is installed.
1869 * Each module will receive hook_civicrm_install during its own installation (but not during the
1870 * installation of unrelated modules).
1872 public static function install() {
1873 // Actually invoke via CRM_Extension_Manager_Module::callHook
1874 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1878 * This hook is called when a module-extension is uninstalled.
1879 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1880 * uninstallation of unrelated modules).
1882 public static function uninstall() {
1883 // Actually invoke via CRM_Extension_Manager_Module::callHook
1884 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1888 * This hook is called when a module-extension is re-enabled.
1889 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1890 * re-enablement of unrelated modules).
1892 public static function enable() {
1893 // Actually invoke via CRM_Extension_Manager_Module::callHook
1894 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1898 * This hook is called when a module-extension is disabled.
1899 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1900 * disablement of unrelated modules).
1902 public static function disable() {
1903 // Actually invoke via CRM_Extension_Manager_Module::callHook
1904 throw new \
RuntimeException(sprintf("The method %s::%s is just a documentation stub and should not be invoked directly.", __CLASS__
, __FUNCTION__
));
1910 * This hook is called when the browser is being re-directed and allows the url
1913 * @param \Psr\Http\Message\UriInterface $url
1914 * @param array $context
1915 * Additional information about context
1916 * - output - if this is 'json' then it will return json.
1919 * the return value is ignored
1921 public static function alterRedirect(&$url, &$context) {
1922 return self
::singleton()->invoke(['url', 'context'], $url,
1923 $context, self
::$_nullObject,
1924 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1925 'civicrm_alterRedirect'
1936 public static function alterReportVar($varType, &$var, &$object) {
1937 return self
::singleton()->invoke(['varType', 'var', 'object'], $varType, $var, $object,
1939 self
::$_nullObject, self
::$_nullObject,
1940 'civicrm_alterReportVar'
1945 * This hook is called to drive database upgrades for extension-modules.
1948 * The type of operation being performed; 'check' or 'enqueue'.
1949 * @param CRM_Queue_Queue $queue
1950 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1953 * NULL, if $op is 'enqueue'.
1954 * TRUE, if $op is 'check' and upgrades are pending.
1955 * FALSE, if $op is 'check' and upgrades are not pending.
1957 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1958 return self
::singleton()->invoke(['op', 'queue'], $op, $queue,
1959 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1966 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1968 * @param array $params
1969 * The mailing parameters. Array fields include: groupName, from, toName,
1970 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1971 * attachments (array)
1975 public static function postEmailSend(&$params) {
1976 return self
::singleton()->invoke(['params'], $params,
1977 self
::$_nullObject, self
::$_nullObject,
1978 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1979 'civicrm_postEmailSend'
1984 * This hook is called when a CiviMail mailing has completed
1986 * @param int $mailingId
1991 public static function postMailing($mailingId) {
1992 return self
::singleton()->invoke(['mailingId'], $mailingId,
1993 self
::$_nullObject, self
::$_nullObject,
1994 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1995 'civicrm_postMailing'
2000 * This hook is called when Settings specifications are loaded.
2002 * @param array $settingsFolders
2003 * List of paths from which to derive metadata
2007 public static function alterSettingsFolders(&$settingsFolders) {
2008 return self
::singleton()->invoke(['settingsFolders'], $settingsFolders,
2009 self
::$_nullObject, self
::$_nullObject,
2010 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2011 'civicrm_alterSettingsFolders'
2016 * This hook is called when Settings have been loaded from the xml
2017 * It is an opportunity for hooks to alter the data
2019 * @param array $settingsMetaData
2020 * Settings Metadata.
2021 * @param int $domainID
2022 * @param mixed $profile
2026 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
2027 return self
::singleton()->invoke(['settingsMetaData', 'domainID', 'profile'], $settingsMetaData,
2028 $domainID, $profile,
2029 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2030 'civicrm_alterSettingsMetaData'
2035 * This hook is called before running an api call.
2037 * @param API_Wrapper[] $wrappers
2038 * (see CRM_Utils_API_ReloadOption as an example)
2039 * @param mixed $apiRequest
2042 * The return value is ignored
2044 public static function apiWrappers(&$wrappers, $apiRequest) {
2045 return self
::singleton()
2046 ->invoke(['wrappers', 'apiRequest'], $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2047 self
::$_nullObject, 'civicrm_apiWrappers'
2052 * This hook is called before running pending cron jobs.
2054 * @param CRM_Core_JobManager $jobManager
2057 * The return value is ignored.
2059 public static function cron($jobManager) {
2060 return self
::singleton()->invoke(['jobManager'],
2061 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2067 * This hook is called when exporting Civi's permission to the CMS. Use this hook to modify
2068 * the array of system permissions for CiviCRM.
2070 * @param array $newPermissions
2071 * Array to be filled with permissions.
2074 * The return value is ignored
2076 public static function permission(&$newPermissions) {
2077 return self
::singleton()->invoke(['permissions'], $newPermissions, self
::$_nullObject,
2078 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2079 'civicrm_permission'
2084 * This hook is used to enumerate the list of available permissions. It may
2085 * include concrete permissions defined by Civi, concrete permissions defined
2086 * by the CMS, and/or synthetic permissions.
2088 * @param array $permissions
2089 * Array of permissions, keyed by symbolic name. Each is an array with fields:
2090 * - group: string (ex: "civicrm", "cms")
2091 * - title: string (ex: "CiviEvent: Register for events")
2092 * - description: string (ex: "Register for events online")
2093 * - is_synthetic: bool (TRUE for synthetic permissions with a bespoke evaluation. FALSE for concrete permissions that registered+granted in the UF user-management layer.
2094 * Default TRUE iff name begins with '@')
2095 * - is_active: bool (TRUE if this permission is defined by. Default: TRUE)
2098 * The return value is ignored
2099 * @see Civi\Api4\Permission::get()
2101 public static function permissionList(&$permissions) {
2102 return self
::singleton()->invoke(['permissions'], $permissions,
2103 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2104 'civicrm_permissionList'
2109 * This hook is called when checking permissions; use this hook to dynamically
2110 * escalate user permissions in certain use cases (cf. CRM-19256).
2112 * @param string $permission
2113 * The name of an atomic permission, ie. 'access deleted contacts'
2114 * @param bool $granted
2115 * Whether this permission is currently granted. The hook can change this value.
2116 * @param int $contactId
2117 * Contact whose permissions we are checking (if null, assume current user).
2120 * The return value is ignored
2122 public static function permission_check($permission, &$granted, $contactId) {
2123 return self
::singleton()->invoke(['permission', 'granted', 'contactId'], $permission, $granted, $contactId,
2124 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2125 'civicrm_permission_check'
2130 * Rotate the cryptographic key used in the database.
2132 * The purpose of this hook is to visit any encrypted values in the database
2133 * and re-encrypt the content.
2135 * For values encoded via `CryptoToken`, you can use `CryptoToken::rekey($oldToken, $tag)`
2137 * @param string $tag
2138 * The type of crypto-key that is currently being rotated.
2139 * The hook-implementer should use this to decide which (if any) fields to visit.
2141 * @param \Psr\Log\LoggerInterface $log
2142 * List of messages about re-keyed values.
2145 * function example_civicrm_rekey($tag, &$log) {
2146 * if ($tag !== 'CRED') return;
2148 * $cryptoToken = Civi::service('crypto.token');
2149 * $rows = sql('SELECT id, secret_column FROM some_table');
2150 * foreach ($rows as $row) {
2151 * $new = $cryptoToken->rekey($row['secret_column']);
2152 * if ($new !== NULL) {
2153 * sql('UPDATE some_table SET secret_column = %1 WHERE id = %2',
2154 * $new, $row['id']);
2161 * The return value is ignored
2163 public static function cryptoRotateKey($tag, $log) {
2164 return self
::singleton()->invoke(['tag', 'log'], $tag, $log, self
::$_nullObject,
2165 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2166 'civicrm_cryptoRotateKey'
2171 * @param CRM_Core_Exception $exception
2172 * @param mixed $request
2173 * Reserved for future use.
2175 public static function unhandledException($exception, $request = NULL) {
2176 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
2177 \Civi
::dispatcher()->dispatch('hook_civicrm_unhandled_exception', $event);
2181 * This hook is called for declaring managed entities via API.
2183 * Note: This is a pre-boot hook. It will dispatch via the extension/module
2184 * subsystem but *not* the Symfony EventDispatcher.
2186 * @param array[] $entityTypes
2187 * List of entity types; each entity-type is an array with keys:
2188 * - name: string, a unique short name (e.g. "ReportInstance")
2189 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
2190 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
2191 * - fields_callback: array, list of callables which manipulates field list
2192 * - links_callback: array, list of callables which manipulates fk list
2195 * The return value is ignored
2197 public static function entityTypes(&$entityTypes) {
2198 return self
::singleton()->invoke(['entityTypes'], $entityTypes, self
::$_nullObject, self
::$_nullObject,
2199 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
2204 * Build a description of available hooks.
2206 * @param \Civi\Core\CiviEventInspector $inspector
2208 public static function eventDefs($inspector) {
2209 $event = \Civi\Core\Event\GenericHookEvent
::create([
2210 'inspector' => $inspector,
2212 Civi
::dispatcher()->dispatch('hook_civicrm_eventDefs', $event);
2216 * This hook is called while preparing a profile form.
2218 * @param string $profileName
2221 public static function buildProfile($profileName) {
2222 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2223 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
2227 * This hook is called while validating a profile form submission.
2229 * @param string $profileName
2232 public static function validateProfile($profileName) {
2233 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2234 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
2238 * This hook is called processing a valid profile form submission.
2240 * @param string $profileName
2243 public static function processProfile($profileName) {
2244 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2245 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
2249 * This hook is called while preparing a read-only profile screen
2251 * @param string $profileName
2254 public static function viewProfile($profileName) {
2255 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2256 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
2260 * This hook is called while preparing a list of contacts (based on a profile)
2262 * @param string $profileName
2265 public static function searchProfile($profileName) {
2266 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2267 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
2271 * This hook is invoked when building a CiviCRM name badge.
2273 * @param string $labelName
2274 * String referencing name of badge format.
2275 * @param object $label
2276 * Reference to the label object.
2277 * @param array $format
2278 * Array of format data.
2279 * @param array $participant
2280 * Array of participant values.
2283 * the return value is ignored
2285 public static function alterBadge($labelName, &$label, &$format, &$participant) {
2286 return self
::singleton()
2287 ->invoke(['labelName', 'label', 'format', 'participant'], $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
2291 * This hook is called before encoding data in barcode.
2293 * @param array $data
2294 * Associated array of values available for encoding.
2295 * @param string $type
2296 * Type of barcode, classic barcode or QRcode.
2297 * @param string $context
2298 * Where this hooks is invoked.
2302 public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
2303 return self
::singleton()->invoke(['data', 'type', 'context'], $data, $type, $context, self
::$_nullObject,
2304 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
2308 * Modify or replace the Mailer object used for outgoing mail.
2310 * @param object $mailer
2311 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2312 * @param string $driver
2313 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2314 * @param array $params
2315 * The default mailer config options
2318 * @see Mail::factory
2320 public static function alterMailer(&$mailer, $driver, $params) {
2321 return self
::singleton()
2322 ->invoke(['mailer', 'driver', 'params'], $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
2326 * This hook is called while building the core search query,
2327 * so hook implementers can provide their own query objects which alters/extends core search.
2329 * @param array $queryObjects
2330 * @param string $type
2334 public static function queryObjects(&$queryObjects, $type = 'Contact') {
2335 return self
::singleton()
2336 ->invoke(['queryObjects', 'type'], $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
2340 * This hook is called while initializing the default dashlets for a contact dashboard.
2342 * @param array $availableDashlets
2343 * List of dashlets; each is formatted per api/v3/Dashboard
2344 * @param array $defaultDashlets
2345 * List of dashlets; each is formatted per api/v3/DashboardContact
2349 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
2350 return self
::singleton()
2351 ->invoke(['availableDashlets', 'defaultDashlets'], $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
2355 * This hook is called before a case merge (or a case reassign)
2357 * @param int $mainContactId
2358 * @param int $mainCaseId
2359 * @param int $otherContactId
2360 * @param int $otherCaseId
2361 * @param bool $changeClient
2365 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2366 return self
::singleton()
2367 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
2371 * This hook is called after a case merge (or a case reassign)
2373 * @param int $mainContactId
2374 * @param int $mainCaseId
2375 * @param int $otherContactId
2376 * @param int $otherCaseId
2377 * @param bool $changeClient
2381 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2382 return self
::singleton()
2383 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
2388 * Add a hook for altering the display name
2390 * hook_civicrm_contact_get_displayname(&$display_name, $contactId, $dao)
2392 * @param string $displayName
2393 * @param int $contactId
2394 * @param CRM_Core_DAO $dao
2395 * A DAO object containing contact fields + primary email field as "email".
2399 public static function alterDisplayName(&$displayName, $contactId, $dao) {
2400 return self
::singleton()->invoke(['displayName', 'contactId', 'dao'],
2401 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
2402 self
::$_nullObject, 'civicrm_contact_get_displayname'
2407 * Modify the CRM_Core_Resources settings data.
2409 * @param array $data
2410 * @see CRM_Core_Resources::addSetting
2412 public static function alterResourceSettings(&$data) {
2413 $event = \Civi\Core\Event\GenericHookEvent
::create([
2416 Civi
::dispatcher()->dispatch('hook_civicrm_alterResourceSettings', $event);
2420 * EXPERIMENTAL: This hook allows one to register additional Angular modules
2422 * @param array $angularModules
2423 * List of modules. Each module defines:
2424 * - ext: string, the CiviCRM extension which hosts the files.
2425 * - js: array, list of JS files or globs.
2426 * - css: array, list of CSS files or globs.
2427 * - partials: array, list of base-dirs containing HTML.
2428 * - partialsCallback: mixed, a callback function which generates a list of HTML
2429 * function(string $moduleName, array $moduleDefn) => array(string $file => string $html)
2430 * For future-proofing, use a serializable callback (e.g. string/array).
2431 * See also: Civi\Core\Resolver.
2432 * - requires: array, list of required Angular modules.
2433 * - basePages: array, uncondtionally load this module onto the given Angular pages. [v4.7.21+]
2434 * If omitted, default to "array('civicrm/a')" for backward compat.
2435 * For a utility that should only be loaded on-demand, use "array()".
2436 * For a utility that should be loaded in all pages use, "array('*')".
2439 * function mymod_civicrm_angularModules(&$angularModules) {
2440 * $angularModules['myAngularModule'] = array(
2441 * 'ext' => 'org.example.mymod',
2442 * 'js' => array('js/myAngularModule.js'),
2444 * $angularModules['myBigAngularModule'] = array(
2445 * 'ext' => 'org.example.mymod',
2446 * 'js' => array('js/part1.js', 'js/part2.js', 'ext://other.ext.name/file.js', 'assetBuilder://dynamicAsset.js'),
2447 * 'css' => array('css/myAngularModule.css', 'ext://other.ext.name/file.css', 'assetBuilder://dynamicAsset.css'),
2448 * 'partials' => array('partials/myBigAngularModule'),
2449 * 'requires' => array('otherModuleA', 'otherModuleB'),
2450 * 'basePages' => array('civicrm/a'),
2456 * the return value is ignored
2458 public static function angularModules(&$angularModules) {
2459 return self
::singleton()->invoke(['angularModules'], $angularModules,
2460 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2461 'civicrm_angularModules'
2466 * Alter the definition of some Angular HTML partials.
2468 * @param \Civi\Angular\Manager $angular
2471 * function example_civicrm_alterAngular($angular) {
2472 * $changeSet = \Civi\Angular\ChangeSet::create('mychanges')
2473 * ->alterHtml('~/crmMailing/EditMailingCtrl/2step.html', function(phpQueryObject $doc) {
2474 * $doc->find('[ng-form="crmMailingSubform"]')->attr('cat-stevens', 'ts(\'wild world\')');
2477 * $angular->add($changeSet);
2481 public static function alterAngular($angular) {
2482 $event = \Civi\Core\Event\GenericHookEvent
::create([
2483 'angular' => $angular,
2485 Civi
::dispatcher()->dispatch('hook_civicrm_alterAngular', $event);
2489 * This hook is called when building a link to a semi-static asset.
2491 * @param string $asset
2492 * The name of the asset.
2493 * Ex: 'angular.json'
2494 * @param array $params
2495 * List of optional arguments which influence the content.
2497 * the return value is ignored
2499 public static function getAssetUrl(&$asset, &$params) {
2500 return self
::singleton()->invoke(['asset', 'params'],
2501 $asset, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2502 'civicrm_getAssetUrl'
2507 * This hook is called whenever the system builds a new copy of
2508 * semi-static asset.
2510 * @param string $asset
2511 * The name of the asset.
2512 * Ex: 'angular.json'
2513 * @param array $params
2514 * List of optional arguments which influence the content.
2515 * Note: Params are immutable because they are part of the cache-key.
2516 * @param string $mimeType
2517 * Initially, NULL. Modify to specify the mime-type.
2518 * @param string $content
2519 * Initially, NULL. Modify to specify the rendered content.
2521 * the return value is ignored
2523 public static function buildAsset($asset, $params, &$mimeType, &$content) {
2524 return self
::singleton()->invoke(['asset', 'params', 'mimeType', 'content'],
2525 $asset, $params, $mimeType, $content, self
::$_nullObject, self
::$_nullObject,
2526 'civicrm_buildAsset'
2531 * This hook fires whenever a record in a case changes.
2533 * @param \Civi\CCase\Analyzer $analyzer
2534 * A bundle of data about the case (such as the case and activity records).
2536 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
2537 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
2538 \Civi
::dispatcher()->dispatch('hook_civicrm_caseChange', $event);
2542 * Modify the CiviCRM container - add new services, parameters, extensions, etc.
2545 * use Symfony\Component\Config\Resource\FileResource;
2546 * use Symfony\Component\DependencyInjection\Definition;
2548 * function mymodule_civicrm_container($container) {
2549 * $container->addResource(new FileResource(__FILE__));
2550 * $container->setDefinition('mysvc', new Definition('My\Class', array()));
2554 * Tip: The container configuration will be compiled/cached. The default cache
2555 * behavior is aggressive. When you first implement the hook, be sure to
2556 * flush the cache. Additionally, you should relax caching during development.
2557 * In `civicrm.settings.php`, set define('CIVICRM_CONTAINER_CACHE', 'auto').
2559 * Note: This is a preboot hook. It will dispatch via the extension/module
2560 * subsystem but *not* the Symfony EventDispatcher.
2562 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
2563 * @see http://symfony.com/doc/current/components/dependency_injection/index.html
2565 public static function container(\Symfony\Component\DependencyInjection\ContainerBuilder
$container) {
2566 self
::singleton()->invoke(['container'], $container, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_container');
2570 * @param array $fileSearches CRM_Core_FileSearchInterface
2573 public static function fileSearches(&$fileSearches) {
2574 return self
::singleton()->invoke(['fileSearches'], $fileSearches,
2575 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2576 'civicrm_fileSearches'
2581 * Check system status.
2583 * @param CRM_Utils_Check_Message[] $messages
2584 * A list of messages regarding system status
2585 * @param array $statusNames
2586 * If specified, only these checks are being requested and others should be skipped
2587 * @param bool $includeDisabled
2588 * Run checks that have been explicitly disabled (default false)
2591 public static function check(&$messages, $statusNames = [], $includeDisabled = FALSE) {
2592 return self
::singleton()->invoke(['messages', 'statusNames', 'includeDisabled'],
2593 $messages, $statusNames, $includeDisabled,
2594 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2600 * This hook is called when a query string of the CSV Batch export is generated.
2602 * @param string $query
2606 public static function batchQuery(&$query) {
2607 return self
::singleton()->invoke(['query'], $query, self
::$_nullObject,
2608 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2609 'civicrm_batchQuery'
2614 * This hook is called to alter Deferred revenue item values just before they are
2615 * inserted in civicrm_financial_trxn table
2617 * @param array $deferredRevenues
2618 * @param CRM_Contribute_BAO_Contribution $contributionDetails
2619 * @param bool $update
2620 * @param string $context
2624 public static function alterDeferredRevenueItems(&$deferredRevenues, $contributionDetails, $update, $context) {
2625 return self
::singleton()->invoke(['deferredRevenues', 'contributionDetails', 'update', 'context'], $deferredRevenues, $contributionDetails, $update, $context,
2626 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterDeferredRevenueItems'
2631 * This hook is called when the entries of the CSV Batch export are mapped.
2633 * @param array $results
2634 * @param array $items
2638 public static function batchItems(&$results, &$items) {
2639 return self
::singleton()->invoke(['results', 'items'], $results, $items,
2640 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2641 'civicrm_batchItems'
2646 * This hook is called when core resources are being loaded
2648 * @see CRM_Core_Resources::coreResourceList
2650 * @param array $list
2651 * @param string $region
2653 public static function coreResourceList(&$list, $region) {
2654 self
::singleton()->invoke(['list', 'region'], $list, $region,
2655 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2656 'civicrm_coreResourceList'
2661 * Allows the list of filters on the EntityRef widget to be altered.
2663 * @see CRM_Core_Resources::entityRefFilters
2665 * @param array $filters
2666 * @param array $links
2668 public static function entityRefFilters(&$filters, &$links = NULL) {
2669 self
::singleton()->invoke(['filters', 'links'], $filters, $links, self
::$_nullObject,
2670 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2671 'civicrm_entityRefFilters'
2676 * This hook is called for bypass a few civicrm urls from IDS check.
2678 * @param array $skip list of civicrm urls
2682 public static function idsException(&$skip) {
2683 return self
::singleton()->invoke(['skip'], $skip, self
::$_nullObject,
2684 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2685 'civicrm_idsException'
2690 * This hook is called when a geocoder's format method is called.
2692 * @param string $geoProvider
2693 * @param array $values
2694 * @param SimpleXMLElement $xml
2698 public static function geocoderFormat($geoProvider, &$values, $xml) {
2699 return self
::singleton()->invoke(['geoProvider', 'values', 'xml'], $geoProvider, $values, $xml,
2700 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2701 'civicrm_geocoderFormat'
2706 * This hook is called before an inbound SMS is processed.
2708 * @param \CRM_SMS_Message $message
2709 * An SMS message received
2712 public static function inboundSMS(&$message) {
2713 return self
::singleton()->invoke(['message'], $message, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_inboundSMS');
2717 * This hook is called to modify api params of EntityRef form field
2719 * @param array $params
2720 * @param string $formName
2723 public static function alterEntityRefParams(&$params, $formName) {
2724 return self
::singleton()->invoke(['params', 'formName'], $params, $formName,
2725 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2726 'civicrm_alterEntityRefParams'
2731 * This hook is called before a scheduled job is executed
2733 * @param CRM_Core_DAO_Job $job
2734 * The job to be executed
2735 * @param array $params
2736 * The arguments to be given to the job
2738 public static function preJob($job, $params) {
2739 return self
::singleton()->invoke(['job', 'params'], $job, $params,
2740 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2746 * This hook is called after a scheduled job is executed
2748 * @param CRM_Core_DAO_Job $job
2749 * The job that was executed
2750 * @param array $params
2751 * The arguments given to the job
2752 * @param array $result
2753 * The result of the API call, or the thrown exception if any
2755 public static function postJob($job, $params, $result) {
2756 return self
::singleton()->invoke(['job', 'params', 'result'], $job, $params, $result,
2757 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2763 * This hook is called before and after constructing mail recipients.
2764 * Allows user to alter filter and/or search query to fetch mail recipients
2766 * @param CRM_Mailing_DAO_Mailing $mailingObject
2767 * @param array $criteria
2768 * A list of SQL criteria; you can add/remove/replace/modify criteria.
2769 * Array(string $name => CRM_Utils_SQL_Select $criterion).
2770 * Ex: array('do_not_email' => CRM_Utils_SQL_Select::fragment()->where("$contact.do_not_email = 0")).
2771 * @param string $context
2775 public static function alterMailingRecipients(&$mailingObject, &$criteria, $context) {
2776 return self
::singleton()->invoke(['mailingObject', 'params', 'context'],
2777 $mailingObject, $criteria, $context,
2778 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2779 'civicrm_alterMailingRecipients'
2784 * ALlow Extensions to custom process IPN hook data such as sending Google Analyitcs information based on the IPN
2785 * @param array $IPNData - Array of IPN Data
2788 public static function postIPNProcess(&$IPNData) {
2789 return self
::singleton()->invoke(['IPNData'],
2790 $IPNData, self
::$_nullObject, self
::$_nullObject,
2791 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2792 'civicrm_postIPNProcess'
2797 * Allow extensions to modify the array of acceptable fields to be included on profiles
2798 * @param array $fields
2799 * format is [Entity => array of DAO fields]
2802 public static function alterUFFields(&$fields) {
2803 return self
::singleton()->invoke(['fields'],
2804 $fields, self
::$_nullObject, self
::$_nullObject,
2805 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2806 'civicrm_alterUFFields'
2811 * This hook is called to alter Custom field value before its displayed.
2813 * @param string $displayValue
2814 * @param mixed $value
2815 * @param int $entityId
2816 * @param array $fieldInfo
2820 public static function alterCustomFieldDisplayValue(&$displayValue, $value, $entityId, $fieldInfo) {
2821 return self
::singleton()->invoke(
2822 ['displayValue', 'value', 'entityId', 'fieldInfo'],
2823 $displayValue, $value, $entityId, $fieldInfo, self
::$_nullObject,
2824 self
::$_nullObject, 'civicrm_alterCustomFieldDisplayValue'
2829 * Alter APIv4 route permissions based on the Entity and Action
2831 * This is an experimental hook intended to *relax* the requirement
2832 * for "access AJAX API" when calling public-oriented APIs.
2834 * Historically, when APIv2/v3 were first exposed to an HTTP interface, using
2835 * the HTTP interface required an extra permission "access AJAX API". This is a
2836 * broad hedge against security flaws within those API's. In the current APIv4
2837 * era, security concerns are often baked into each API, so there is a debate about
2838 * whether "access AJAX API" serves a purpose or just makes
2839 * administration/development more complicated. (So far, there's more support
2842 * This hook might foreseeably be abandoned either...
2844 * - if it is found that "access AJAX API" guard is not needed for APIv4.
2845 * - if the policy is moved into metadata.
2847 * @param array|string $permissions
2848 * @param string $entity
2849 * @param string $action
2853 public static function alterApiRoutePermissions(&$permissions, $entity, $action) {
2854 return self
::singleton()->invoke(
2855 ['permissions', 'entity', 'action'],
2856 $permissions, $entity, $action, self
::$_nullObject, self
::$_nullObject,
2857 self
::$_nullObject, 'civicrm_alterApiRoutePermissions'
2862 * Allows an extension to override the checksum validation.
2863 * For example you may want to invalidate checksums that were sent out/forwarded by mistake. You could also
2864 * intercept and redirect to a different page in this case - eg. to say "sorry, you tried to use a compromised
2867 * @param int $contactID
2868 * @param string $checksum
2869 * @param bool $invalid
2870 * Leave this at FALSE to allow the core code to perform validation. Set to TRUE to invalidate
2872 public static function invalidateChecksum($contactID, $checksum, &$invalid) {
2873 return self
::singleton()->invoke(
2874 ['contactID', 'checksum', 'invalid'],
2875 $contactID, $checksum, $invalid, self
::$_nullObject, self
::$_nullObject,
2876 self
::$_nullObject, 'civicrm_invalidateChecksum'