3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * @package CiviCRM_Hook
31 * @copyright CiviCRM LLC (c) 2004-2019
33 abstract class CRM_Utils_Hook
{
35 // Allowed values for dashboard hook content placement
36 // Default - place content below activity list
37 const DASHBOARD_BELOW
= 1;
38 // Place content above activity list
39 const DASHBOARD_ABOVE
= 2;
40 // Don't display activity list at all
41 const DASHBOARD_REPLACE
= 3;
43 // by default - place content below existing content
44 const SUMMARY_BELOW
= 1;
45 // place hook content above
46 const SUMMARY_ABOVE
= 2;
48 *create your own summaries
50 const SUMMARY_REPLACE
= 3;
53 * Object to pass when an object is required to be passed by params.
55 * This is supposed to be a convenience but note that it is a bad
56 * pattern as it can get contaminated & result in hard-to-diagnose bugs.
60 public static $_nullObject = NULL;
63 * We only need one instance of this object. So we use the singleton
64 * pattern and cache the instance in this variable
68 static private $_singleton = NULL;
73 private $commonIncluded = FALSE;
78 private $commonCiviModules = [];
81 * @var CRM_Utils_Cache_Interface
86 * Constructor and getter for the singleton instance.
90 * @return CRM_Utils_Hook
91 * An instance of $config->userHookClass
93 public static function singleton($fresh = FALSE) {
94 if (self
::$_singleton == NULL ||
$fresh) {
95 $config = CRM_Core_Config
::singleton();
96 $class = $config->userHookClass
;
97 self
::$_singleton = new $class();
99 return self
::$_singleton;
103 * CRM_Utils_Hook constructor.
105 * @throws \CRM_Core_Exception
107 public function __construct() {
108 $this->cache
= CRM_Utils_Cache
::create([
110 'type' => ['ArrayCache'],
116 * Invoke a hook through the UF/CMS hook system and the extension-hook
119 * @param int $numParams
120 * Number of parameters to pass to the hook.
122 * Parameter to be passed to the hook.
124 * Parameter to be passed to the hook.
126 * Parameter to be passed to the hook.
128 * Parameter to be passed to the hook.
130 * Parameter to be passed to the hook.
132 * Parameter to be passed to the hook.
133 * @param string $fnSuffix
134 * Function suffix, this is effectively the hook name.
138 abstract public function invokeViaUF(
140 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
147 * This is a transitional adapter. It supports the legacy syntax
148 * but also accepts enough information to support Symfony Event
151 * @param array|int $names
152 * (Recommended) Array of parameter names, in order.
153 * Using an array is recommended because it enables full
154 * event-broadcasting behaviors.
155 * (Legacy) Number of parameters to pass to the hook.
156 * This is provided for transitional purposes.
163 * @param mixed $fnSuffix
166 public function invoke(
168 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
171 // Per https://github.com/civicrm/civicrm-core/pull/13551 we have had ongoing significant problems where hooks from modules are
172 // invoked during upgrade but not those from extensions. The issues are both that an incorrect module list & settings are cached and that
173 // some hooks REALLY need to run during upgrade - the loss of triggers during upgrade causes significant loss of data
174 // whereas loss of logTable hooks means that log tables are created for tables specifically excluded - e.g due to large
175 // quantities of low-importance data or the table not having an id field, which could cause a fatal error.
176 // Instead of not calling any hooks we only call those we know to be frequently important - if a particular extension wanted
177 // to avoid this they could do an early return on CRM_Core_Config::singleton()->isUpgradeMode
178 $upgradeFriendlyHooks = ['civicrm_alterSettingsFolders', 'civicrm_alterSettingsMetaData', 'civicrm_triggerInfo', 'civicrm_alterLogTables', 'civicrm_container'];
179 if (CRM_Core_Config
::singleton()->isUpgradeMode() && !in_array($fnSuffix, $upgradeFriendlyHooks)) {
182 if (is_array($names) && !defined('CIVICRM_FORCE_LEGACY_HOOK') && \Civi\Core\Container
::isContainerBooted()) {
183 $event = \Civi\Core\Event\GenericHookEvent
::createOrdered(
185 array(&$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6)
187 \Civi
::dispatcher()->dispatch('hook_' . $fnSuffix, $event);
188 return $event->getReturnValues();
191 $count = is_array($names) ?
count($names) : $names;
192 return $this->invokeViaUF($count, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $fnSuffix);
197 * @param array $numParams
209 public function commonInvoke(
211 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
215 $this->commonBuildModuleList($fnPrefix);
217 return $this->runHooks($this->commonCiviModules
, $fnSuffix,
218 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
223 * Build the list of modules to be processed for hooks.
225 * @param string $fnPrefix
227 public function commonBuildModuleList($fnPrefix) {
228 if (!$this->commonIncluded
) {
229 // include external file
230 $this->commonIncluded
= TRUE;
232 $config = CRM_Core_Config
::singleton();
233 if (!empty($config->customPHPPathDir
)) {
234 $civicrmHooksFile = CRM_Utils_File
::addTrailingSlash($config->customPHPPathDir
) . 'civicrmHooks.php';
235 if (file_exists($civicrmHooksFile)) {
236 @include_once
$civicrmHooksFile;
240 if (!empty($fnPrefix)) {
241 $this->commonCiviModules
[$fnPrefix] = $fnPrefix;
244 $this->requireCiviModules($this->commonCiviModules
);
251 * @param array $civiModules
252 * @param string $fnSuffix
253 * @param int $numParams
264 public function runHooks(
265 $civiModules, $fnSuffix, $numParams,
266 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6
268 // $civiModules is *not* passed by reference because runHooks
269 // must be reentrant. PHP is finicky about running
270 // multiple loops over the same variable. The circumstances
271 // to reproduce the issue are pretty intricate.
274 $fnNames = $this->cache
->get($fnSuffix);
275 if (!is_array($fnNames)) {
277 if ($civiModules !== NULL) {
278 foreach ($civiModules as $module) {
279 $fnName = "{$module}_{$fnSuffix}";
280 if (function_exists($fnName)) {
281 $fnNames[] = $fnName;
284 $this->cache
->set($fnSuffix, $fnNames);
288 foreach ($fnNames as $fnName) {
290 switch ($numParams) {
292 $fResult = $fnName();
296 $fResult = $fnName($arg1);
300 $fResult = $fnName($arg1, $arg2);
304 $fResult = $fnName($arg1, $arg2, $arg3);
308 $fResult = $fnName($arg1, $arg2, $arg3, $arg4);
312 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5);
316 $fResult = $fnName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);
320 CRM_Core_Error
::fatal(ts('Invalid hook invocation'));
324 if (!empty($fResult) &&
327 $result = array_merge($result, $fResult);
331 return empty($result) ?
TRUE : $result;
337 public function requireCiviModules(&$moduleList) {
338 $civiModules = CRM_Core_PseudoConstant
::getModuleExtensions();
339 foreach ($civiModules as $civiModule) {
340 if (!file_exists($civiModule['filePath'])) {
341 CRM_Core_Session
::setStatus(
342 ts('Error loading module file (%1). Please restore the file or disable the module.',
343 [1 => $civiModule['filePath']]),
344 ts('Warning'), 'error');
347 include_once $civiModule['filePath'];
348 $moduleList[$civiModule['prefix']] = $civiModule['prefix'];
353 * This hook is called before a db write on some core objects.
354 * This hook does not allow the abort of the operation
357 * The type of operation being performed.
358 * @param string $objectName
359 * The name of the object.
361 * The object id if available.
362 * @param array $params
363 * The parameters used for object creation / editing.
366 * the return value is ignored
368 public static function pre($op, $objectName, $id, &$params) {
369 $event = new \Civi\Core\Event\
PreEvent($op, $objectName, $id, $params);
370 \Civi
::dispatcher()->dispatch('hook_civicrm_pre', $event);
371 return $event->getReturnValues();
375 * This hook is called after a db write on some core objects.
378 * The type of operation being performed.
379 * @param string $objectName
380 * The name of the object.
381 * @param int $objectId
382 * The unique identifier for the object.
383 * @param object $objectRef
384 * The reference to the object if available.
387 * based on op. pre-hooks return a boolean or
388 * an error message which aborts the operation
390 public static function post($op, $objectName, $objectId, &$objectRef = NULL) {
391 $event = new \Civi\Core\Event\
PostEvent($op, $objectName, $objectId, $objectRef);
392 \Civi
::dispatcher()->dispatch('hook_civicrm_post', $event);
393 return $event->getReturnValues();
397 * This hook retrieves links from other modules and injects it into.
398 * the view contact tabs
401 * The type of operation being performed.
402 * @param string $objectName
403 * The name of the object.
404 * @param int $objectId
405 * The unique identifier for the object.
406 * @param array $links
407 * (optional) the links array (introduced in v3.2).
409 * (optional) the bitmask to show/hide links.
410 * @param array $values
411 * (optional) the values to fill the links.
414 * the return value is ignored
416 public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = []) {
417 return self
::singleton()->invoke(['op', 'objectName', 'objectId', 'links', 'mask', 'values'], $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
421 * This hook is invoked during the CiviCRM form preProcess phase.
423 * @param string $formName
424 * The name of the form.
425 * @param CRM_Core_Form $form
426 * Reference to the form object.
429 * the return value is ignored
431 public static function preProcess($formName, &$form) {
432 return self
::singleton()
433 ->invoke(['formName', 'form'], $formName, $form, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_preProcess');
437 * This hook is invoked when building a CiviCRM form. This hook should also
438 * be used to set the default values of a form element
440 * @param string $formName
441 * The name of the form.
442 * @param CRM_Core_Form $form
443 * Reference to the form object.
446 * the return value is ignored
448 public static function buildForm($formName, &$form) {
449 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
450 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
456 * This hook is invoked when a CiviCRM form is submitted. If the module has injected
457 * any form elements, this hook should save the values in the database
459 * @param string $formName
460 * The name of the form.
461 * @param CRM_Core_Form $form
462 * Reference to the form object.
465 * the return value is ignored
467 public static function postProcess($formName, &$form) {
468 return self
::singleton()->invoke(['formName', 'form'], $formName, $form,
469 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
470 'civicrm_postProcess'
475 * This hook is invoked during all CiviCRM form validation. An array of errors
476 * detected is returned. Else we assume validation succeeded.
478 * @param string $formName
479 * The name of the form.
480 * @param array &$fields the POST parameters as filtered by QF
481 * @param array &$files the FILES parameters as sent in by POST
482 * @param array &$form the form object
483 * @param array &$errors the array of errors.
486 * formRule hooks return a boolean or
487 * an array of error messages which display a QF Error
489 public static function validateForm($formName, &$fields, &$files, &$form, &$errors) {
490 return self
::singleton()
491 ->invoke(['formName', 'fields', 'files', 'form', 'errors'],
492 $formName, $fields, $files, $form, $errors, self
::$_nullObject, 'civicrm_validateForm');
496 * This hook is called after a db write on a custom table.
499 * The type of operation being performed.
500 * @param string $groupID
501 * The custom group ID.
502 * @param object $entityID
503 * The entityID of the row in the custom table.
504 * @param array $params
505 * The parameters that were sent into the calling function.
508 * the return value is ignored
510 public static function custom($op, $groupID, $entityID, &$params) {
511 return self
::singleton()
512 ->invoke(['op', 'groupID', 'entityID', 'params'], $op, $groupID, $entityID, $params, self
::$_nullObject, self
::$_nullObject, 'civicrm_custom');
516 * This hook is called when composing the ACL where clause to restrict
517 * visibility of contacts to the logged in user
520 * The type of permission needed.
521 * @param array $tables
522 * (reference ) add the tables that are needed for the select clause.
523 * @param array $whereTables
524 * (reference ) add the tables that are needed for the where clause.
525 * @param int $contactID
526 * The contactID for whom the check is made.
527 * @param string $where
528 * The currrent where clause.
531 * the return value is ignored
533 public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
534 return self
::singleton()
535 ->invoke(['type', 'tables', 'whereTables', 'contactID', 'where'], $type, $tables, $whereTables, $contactID, $where, self
::$_nullObject, 'civicrm_aclWhereClause');
539 * This hook is called when composing the ACL where clause to restrict
540 * visibility of contacts to the logged in user
543 * The type of permission needed.
544 * @param int $contactID
545 * The contactID for whom the check is made.
546 * @param string $tableName
547 * The tableName which is being permissioned.
548 * @param array $allGroups
549 * The set of all the objects for the above table.
550 * @param array $currentGroups
551 * The set of objects that are currently permissioned for this contact.
554 * the return value is ignored
556 public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
557 return self
::singleton()
558 ->invoke(['type', 'contactID', 'tableName', 'allGroups', 'currentGroups'], $type, $contactID, $tableName, $allGroups, $currentGroups, self
::$_nullObject, 'civicrm_aclGroup');
562 * @param string|CRM_Core_DAO $entity
563 * @param array $clauses
566 public static function selectWhereClause($entity, &$clauses) {
567 $entityName = is_object($entity) ?
_civicrm_api_get_entity_name_from_dao($entity) : $entity;
568 return self
::singleton()->invoke(['entity', 'clauses'], $entityName, $clauses,
569 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
570 'civicrm_selectWhereClause'
575 * This hook is called when building the menu table.
577 * @param array $files
578 * The current set of files to process.
581 * the return value is ignored
583 public static function xmlMenu(&$files) {
584 return self
::singleton()->invoke(['files'], $files,
585 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
591 * (Experimental) This hook is called when build the menu table.
593 * @param array $items
594 * List of records to include in menu table.
596 * the return value is ignored
598 public static function alterMenu(&$items) {
599 return self
::singleton()->invoke(['items'], $items,
600 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
606 * A theme is a set of CSS files which are loaded on CiviCRM pages. To register a new
607 * theme, add it to the $themes array. Use these properties:
609 * - ext: string (required)
610 * The full name of the extension which defines the theme.
611 * Ex: "org.civicrm.themes.greenwich".
612 * - title: string (required)
614 * - help: string (optional)
615 * Description of the theme's appearance.
616 * - url_callback: mixed (optional)
617 * A function ($themes, $themeKey, $cssExt, $cssFile) which returns the URL(s) for a CSS resource.
618 * Returns either an array of URLs or PASSTHRU.
619 * Ex: \Civi\Core\Themes\Resolvers::simple (default)
620 * Ex: \Civi\Core\Themes\Resolvers::none
621 * - prefix: string (optional)
622 * A prefix within the extension folder to prepend to the file name.
623 * - search_order: array (optional)
624 * A list of themes to search.
625 * Generally, the last theme should be "*fallback*" (Civi\Core\Themes::FALLBACK).
626 * - excludes: array (optional)
627 * A list of files (eg "civicrm:css/bootstrap.css" or "$ext:$file") which should never
628 * be returned (they are excluded from display).
630 * @param array $themes
631 * List of themes, keyed by name.
633 * the return value is ignored
635 public static function themes(&$themes) {
636 return self
::singleton()->invoke(1, $themes,
637 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
643 * The activeTheme hook determines which theme is active.
645 * @param string $theme
646 * The identifier for the theme. Alterable.
648 * @param array $context
649 * Information about the current page-request. Includes some mix of:
650 * - page: the relative path of the current Civi page (Ex: 'civicrm/dashboard').
651 * - themes: an instance of the Civi\Core\Themes service.
653 * the return value is ignored
655 public static function activeTheme(&$theme, $context) {
656 return self
::singleton()->invoke(array('theme', 'context'), $theme, $context,
657 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
658 'civicrm_activeTheme'
663 * This hook is called for declaring managed entities via API.
665 * @param array $entities
666 * List of pending entities. Each entity is an array with keys:
667 * + '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")
668 * + 'name': string, a symbolic name which can be used to track this entity (Note: Each module creates its own namespace)
669 * + 'entity': string, an entity-type supported by the CiviCRM API (Note: this currently must be an entity which supports the 'is_active' property)
670 * + 'params': array, the entity data as supported by the CiviCRM API
671 * + 'update' (v4.5+): string, a policy which describes when to update records
672 * - 'always' (default): always update the managed-entity record; changes in $entities will override any local changes (eg by the site-admin)
673 * - 'never': never update the managed-entity record; changes made locally (eg by the site-admin) will override changes in $entities
674 * + '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)
675 * - 'always' (default): always delete orphaned records
676 * - 'never': never delete orphaned records
677 * - '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.)
680 * the return value is ignored
682 public static function managed(&$entities) {
683 return self
::singleton()->invoke(['entities'], $entities,
684 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
690 * This hook is called when rendering the dashboard (q=civicrm/dashboard)
692 * @param int $contactID
693 * The contactID for whom the dashboard is being rendered.
694 * @param int $contentPlacement
695 * (output parameter) where should the hook content be displayed.
696 * relative to the activity list
699 * the html snippet to include in the dashboard
701 public static function dashboard($contactID, &$contentPlacement = self
::DASHBOARD_BELOW
) {
702 $retval = self
::singleton()->invoke(['contactID', 'contentPlacement'], $contactID, $contentPlacement,
703 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
708 * Note we need this seemingly unnecessary code because in the event that the implementation
709 * of the hook declares the second parameter but doesn't set it, then it comes back unset even
710 * though we have a default value in this function's declaration above.
712 if (!isset($contentPlacement)) {
713 $contentPlacement = self
::DASHBOARD_BELOW
;
720 * This hook is called before storing recently viewed items.
722 * @param array $recentArray
723 * An array of recently viewed or processed items, for in place modification.
727 public static function recent(&$recentArray) {
728 return self
::singleton()->invoke(['recentArray'], $recentArray,
729 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
735 * Determine how many other records refer to a given record.
737 * @param CRM_Core_DAO $dao
738 * The item for which we want a reference count.
739 * @param array $refCounts
740 * Each item in the array is an Array with keys:
741 * - name: string, eg "sql:civicrm_email:contact_id"
742 * - type: string, eg "sql"
743 * - count: int, eg "5" if there are 5 email addresses that refer to $dao
746 * Return is not really intended to be used.
748 public static function referenceCounts($dao, &$refCounts) {
749 return self
::singleton()->invoke(['dao', 'refCounts'], $dao, $refCounts,
750 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
751 'civicrm_referenceCounts'
756 * This hook is called when building the amount structure for a Contribution or Event Page.
758 * @param int $pageType
759 * Is this a contribution or event page.
760 * @param CRM_Core_Form $form
761 * Reference to the form object.
762 * @param array $amount
763 * The amount structure to be displayed.
767 public static function buildAmount($pageType, &$form, &$amount) {
768 return self
::singleton()->invoke(['pageType', 'form', 'amount'], $pageType, $form, $amount, self
::$_nullObject,
769 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildAmount');
773 * This hook is called when building the state list for a particular country.
775 * @param array $countryID
776 * The country id whose states are being selected.
781 public static function buildStateProvinceForCountry($countryID, &$states) {
782 return self
::singleton()->invoke(['countryID', 'states'], $countryID, $states,
783 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
784 'civicrm_buildStateProvinceForCountry'
789 * This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c
792 * The array of tabs that will be displayed.
793 * @param int $contactID
794 * The contactID for whom the dashboard is being rendered.
797 * @deprecated Use tabset() instead.
799 public static function tabs(&$tabs, $contactID) {
800 return self
::singleton()->invoke(['tabs', 'contactID'], $tabs, $contactID,
801 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabs'
806 * This hook is called when rendering the tabs used for events and potentially
807 * contribution pages, etc.
809 * @param string $tabsetName
810 * Name of the screen or visual element.
812 * Tabs that will be displayed.
813 * @param array $context
814 * Extra data about the screen or context in which the tab is used.
818 public static function tabset($tabsetName, &$tabs, $context) {
819 return self
::singleton()->invoke(['tabsetName', 'tabs', 'context'], $tabsetName, $tabs,
820 $context, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tabset'
825 * This hook is called when sending an email / printing labels
827 * @param array $tokens
828 * The list of tokens that can be used for the contact.
832 public static function tokens(&$tokens) {
833 return self
::singleton()->invoke(['tokens'], $tokens,
834 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_tokens'
839 * This hook allows modification of the admin panels
841 * @param array $panels
842 * Associated array of admin panels
846 public static function alterAdminPanel(&$panels) {
847 return self
::singleton()->invoke(array('panels'), $panels,
848 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
849 'civicrm_alterAdminPanel'
854 * This hook is called when sending an email / printing labels to get the values for all the
855 * tokens returned by the 'tokens' hook
857 * @param array $details
858 * The array to store the token values indexed by contactIDs (unless it a single).
859 * @param array $contactIDs
860 * An array of contactIDs.
862 * The jobID if this is associated with a CiviMail mailing.
863 * @param array $tokens
864 * The list of tokens associated with the content.
865 * @param string $className
866 * The top level className from where the hook is invoked.
870 public static function tokenValues(
877 return self
::singleton()
878 ->invoke(['details', 'contactIDs', 'jobID', 'tokens', 'className'], $details, $contactIDs, $jobID, $tokens, $className, self
::$_nullObject, 'civicrm_tokenValues');
882 * This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables
885 * @param object $page
886 * The page that will be rendered.
890 public static function pageRun(&$page) {
891 return self
::singleton()->invoke(['page'], $page,
892 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
898 * This hook is called after a copy of an object has been made. The current objects are
899 * Event, Contribution Page and UFGroup
901 * @param string $objectName
902 * Name of the object.
903 * @param object $object
904 * Reference to the copy.
908 public static function copy($objectName, &$object) {
909 return self
::singleton()->invoke(['objectName', 'object'], $objectName, $object,
910 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
916 * This hook is called when a contact unsubscribes from a mailing. It allows modules
917 * to override what the contacts are removed from.
921 * @param int $mailingId
922 * The id of the mailing to unsub from
923 * @param int $contactId
924 * The id of the contact who is unsubscribing
925 * @param array|int $groups
926 * Groups the contact will be removed from.
927 * @param array|int $baseGroups
928 * Base groups (used in smart mailings) the contact will be removed from.
933 public static function unsubscribeGroups($op, $mailingId, $contactId, &$groups, &$baseGroups) {
934 return self
::singleton()
935 ->invoke(['op', 'mailingId', 'contactId', 'groups', 'baseGroups'], $op, $mailingId, $contactId, $groups, $baseGroups, self
::$_nullObject, 'civicrm_unsubscribeGroups');
939 * This hook is called when CiviCRM needs to edit/display a custom field with options
941 * @deprecated in favor of hook_civicrm_fieldOptions
943 * @param int $customFieldID
944 * The custom field ID.
945 * @param array $options
946 * The current set of options for that custom field.
947 * You can add/remove existing options.
948 * Important: This array may contain meta-data about the field that is needed elsewhere, so it is important
949 * to be careful to not overwrite the array.
950 * Only add/edit/remove the specific field options you intend to affect.
951 * @param bool $detailedFormat
952 * If true, the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
953 * @param array $selectAttributes
954 * Contain select attribute(s) if any.
958 public static function customFieldOptions($customFieldID, &$options, $detailedFormat = FALSE, $selectAttributes = []) {
959 // Weird: $selectAttributes is inputted but not outputted.
960 return self
::singleton()->invoke(['customFieldID', 'options', 'detailedFormat'], $customFieldID, $options, $detailedFormat,
961 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
962 'civicrm_customFieldOptions'
967 * Hook for modifying field options
969 * @param string $entity
970 * @param string $field
971 * @param array $options
972 * @param array $params
976 public static function fieldOptions($entity, $field, &$options, $params) {
977 return self
::singleton()->invoke(['entity', 'field', 'options', 'params'], $entity, $field, $options, $params,
978 self
::$_nullObject, self
::$_nullObject,
979 'civicrm_fieldOptions'
985 * This hook is called to display the list of actions allowed after doing a search.
986 * This allows the module developer to inject additional actions or to remove existing actions.
988 * @param string $objectType
989 * The object type for this search.
990 * - activity, campaign, case, contact, contribution, event, grant, membership, and pledge are supported.
991 * @param array $tasks
992 * The current set of tasks for that custom field.
993 * You can add/remove existing tasks.
994 * Each task needs to have a title (eg 'title' => ts( 'Group - add contacts')) and a class
995 * (eg 'class' => 'CRM_Contact_Form_Task_AddToGroup').
996 * Optional result (boolean) may also be provided. Class can be an array of classes (not sure what that does :( ).
997 * The key for new Task(s) should not conflict with the keys for core tasks of that $objectType, which can be
998 * found in CRM/$objectType/Task.php.
1002 public static function searchTasks($objectType, &$tasks) {
1003 return self
::singleton()->invoke(['objectType', 'tasks'], $objectType, $tasks,
1004 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1005 'civicrm_searchTasks'
1010 * @param mixed $form
1011 * @param array $params
1015 public static function eventDiscount(&$form, &$params) {
1016 return self
::singleton()->invoke(['form', 'params'], $form, $params,
1017 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1018 'civicrm_eventDiscount'
1023 * This hook is called when composing a mailing. You can include / exclude other groups as needed.
1025 * @param mixed $form
1026 * The form object for which groups / mailings being displayed
1027 * @param array $groups
1028 * The list of groups being included / excluded
1029 * @param array $mailings
1030 * The list of mailings being included / excluded
1034 public static function mailingGroups(&$form, &$groups, &$mailings) {
1035 return self
::singleton()->invoke(['form', 'groups', 'mailings'], $form, $groups, $mailings,
1036 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1037 'civicrm_mailingGroups'
1042 * (Experimental) Modify the list of template-types used for CiviMail composition.
1044 * @param array $types
1045 * Sequentially indexed list of template types. Each type specifies:
1047 * - editorUrl: string, Angular template URL
1048 * - weight: int, priority when picking a default value for new mailings
1051 public static function mailingTemplateTypes(&$types) {
1052 return self
::singleton()->invoke(['types'], $types, self
::$_nullObject, self
::$_nullObject,
1053 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1054 'civicrm_mailingTemplateTypes'
1059 * This hook is called when composing the array of membershipTypes and their cost during a membership registration
1061 * Note the hook is called on initial page load and also reloaded after submit (PRG pattern).
1062 * You can use it to alter the membership types when first loaded, or after submission
1063 * (for example if you want to gather data in the form and use it to alter the fees).
1065 * @param mixed $form
1066 * The form object that is presenting the page
1067 * @param array $membershipTypes
1068 * The array of membership types and their amount
1072 public static function membershipTypeValues(&$form, &$membershipTypes) {
1073 return self
::singleton()->invoke(['form', 'membershipTypes'], $form, $membershipTypes,
1074 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1075 'civicrm_membershipTypeValues'
1080 * This hook is called when rendering the contact summary.
1082 * @param int $contactID
1083 * The contactID for whom the summary is being rendered
1084 * @param mixed $content
1085 * @param int $contentPlacement
1086 * Specifies where the hook content should be displayed relative to the
1090 * The html snippet to include in the contact summary
1092 public static function summary($contactID, &$content, &$contentPlacement = self
::SUMMARY_BELOW
) {
1093 return self
::singleton()->invoke(['contactID', 'content', 'contentPlacement'], $contactID, $content, $contentPlacement,
1094 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1100 * Use this hook to populate the list of contacts returned by Contact Reference custom fields.
1101 * By default, Contact Reference fields will search on and return all CiviCRM contacts.
1102 * If you want to limit the contacts returned to a specific group, or some other criteria
1103 * - you can override that behavior by providing a SQL query that returns some subset of your contacts.
1104 * The hook is called when the query is executed to get the list of contacts to display.
1106 * @param mixed $query
1107 * - the query that will be executed (input and output parameter);.
1108 * It's important to realize that the ACL clause is built prior to this hook being fired,
1109 * so your query will ignore any ACL rules that may be defined.
1110 * Your query must return two columns:
1111 * the contact 'data' to display in the autocomplete dropdown (usually contact.sort_name - aliased as 'data')
1113 * @param string $queryText
1114 * The name string to execute the query against (this is the value being typed in by the user).
1115 * @param string $context
1116 * The context in which this ajax call is being made (for example: 'customfield', 'caseview').
1118 * The id of the object for which the call is being made.
1119 * For custom fields, it will be the custom field id
1123 public static function contactListQuery(&$query, $queryText, $context, $id) {
1124 return self
::singleton()->invoke(['query', 'queryText', 'context', 'id'], $query, $queryText, $context, $id,
1125 self
::$_nullObject, self
::$_nullObject,
1126 'civicrm_contactListQuery'
1131 * Hook definition for altering payment parameters before talking to a payment processor back end.
1133 * Definition will look like this:
1135 * function hook_civicrm_alterPaymentProcessorParams(
1141 * @param CRM_Core_Payment $paymentObj
1142 * Instance of payment class of the payment processor invoked (e.g., 'CRM_Core_Payment_Dummy')
1143 * See discussion in CRM-16224 as to whether $paymentObj should be passed by reference.
1144 * @param array &$rawParams
1145 * array of params as passed to to the processor
1146 * @param array &$cookedParams
1147 * params after the processor code has translated them into its own key/value pairs
1150 * This return is not really intended to be used.
1152 public static function alterPaymentProcessorParams(
1157 return self
::singleton()->invoke(['paymentObj', 'rawParams', 'cookedParams'], $paymentObj, $rawParams, $cookedParams,
1158 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1159 'civicrm_alterPaymentProcessorParams'
1164 * This hook is called when an email is about to be sent by CiviCRM.
1166 * @param array $params
1167 * Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
1168 * returnPath, replyTo, headers, attachments (array)
1169 * @param string $context
1170 * The context in which the hook is being invoked, eg 'civimail'.
1174 public static function alterMailParams(&$params, $context = NULL) {
1175 return self
::singleton()->invoke(['params', 'context'], $params, $context,
1176 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1177 'civicrm_alterMailParams'
1182 * This hook is called when membership status is being calculated.
1184 * @param array $membershipStatus
1185 * Membership status details as determined - alter if required.
1186 * @param array $arguments
1187 * Arguments passed in to calculate date.
1192 * - 'exclude_is_admin'
1193 * - 'membership_type_id'
1194 * @param array $membership
1195 * Membership details from the calling function.
1199 public static function alterCalculatedMembershipStatus(&$membershipStatus, $arguments, $membership) {
1200 return self
::singleton()->invoke(['membershipStatus', 'arguments', 'membership'], $membershipStatus, $arguments,
1201 $membership, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1202 'civicrm_alterCalculatedMembershipStatus'
1207 * This hook is called after getting the content of the mail and before tokenizing it.
1209 * @param array $content
1210 * Array fields include: html, text, subject
1214 public static function alterMailContent(&$content) {
1215 return self
::singleton()->invoke(['content'], $content,
1216 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1217 'civicrm_alterMailContent'
1222 * This hook is called when rendering the Manage Case screen.
1224 * @param int $caseID
1228 * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
1229 * and the value is an array with keys 'label' and 'value' specifying label/value pairs
1231 public static function caseSummary($caseID) {
1232 return self
::singleton()->invoke(['caseID'], $caseID,
1233 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1234 'civicrm_caseSummary'
1239 * This hook is called when locating CiviCase types.
1241 * @param array $caseTypes
1245 public static function caseTypes(&$caseTypes) {
1246 return self
::singleton()
1247 ->invoke(['caseTypes'], $caseTypes, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_caseTypes');
1251 * This hook is called soon after the CRM_Core_Config object has ben initialized.
1252 * You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.
1254 * @param CRM_Core_Config|array $config
1259 public static function config(&$config) {
1260 return self
::singleton()->invoke(['config'], $config,
1261 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1267 * This hooks allows to change option values.
1269 * @deprecated in favor of hook_civicrm_fieldOptions
1271 * @param array $options
1272 * Associated array of option values / id
1273 * @param string $groupName
1278 public static function optionValues(&$options, $groupName) {
1279 return self
::singleton()->invoke(['options', 'groupName'], $options, $groupName,
1280 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1281 'civicrm_optionValues'
1286 * This hook allows modification of the navigation menu.
1288 * @param array $params
1289 * Associated array of navigation menu entry to Modify/Add
1293 public static function navigationMenu(&$params) {
1294 return self
::singleton()->invoke(['params'], $params,
1295 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1296 'civicrm_navigationMenu'
1301 * This hook allows modification of the data used to perform merging of duplicates.
1303 * @param string $type
1304 * The type of data being passed (cidRefs|eidRefs|relTables|sqls).
1305 * @param array $data
1306 * The data, as described in $type.
1307 * @param int $mainId
1308 * Contact_id of the contact that survives the merge.
1309 * @param int $otherId
1310 * Contact_id of the contact that will be absorbed and deleted.
1311 * @param array $tables
1312 * When $type is "sqls", an array of tables as it may have been handed to the calling function.
1316 public static function merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
1317 return self
::singleton()->invoke(['type', 'data', 'mainId', 'otherId', 'tables'], $type, $data, $mainId, $otherId, $tables, self
::$_nullObject, 'civicrm_merge');
1321 * This hook allows modification of the data calculated for merging locations.
1323 * @param array $blocksDAO
1324 * Array of location DAO to be saved. These are arrays in 2 keys 'update' & 'delete'.
1325 * @param int $mainId
1326 * Contact_id of the contact that survives the merge.
1327 * @param int $otherId
1328 * Contact_id of the contact that will be absorbed and deleted.
1329 * @param array $migrationInfo
1330 * Calculated migration info, informational only.
1334 public static function alterLocationMergeData(&$blocksDAO, $mainId, $otherId, $migrationInfo) {
1335 return self
::singleton()->invoke(['blocksDAO', 'mainId', 'otherId', 'migrationInfo'], $blocksDAO, $mainId, $otherId, $migrationInfo, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterLocationMergeData');
1339 * This hook provides a way to override the default privacy behavior for notes.
1341 * @param array &$noteValues
1342 * Associative array of values for this note
1346 public static function notePrivacy(&$noteValues) {
1347 return self
::singleton()->invoke(['noteValues'], $noteValues,
1348 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1349 'civicrm_notePrivacy'
1354 * This hook is called before record is exported as CSV.
1356 * @param string $exportTempTable
1357 * Name of the temporary export table used during export.
1358 * @param array $headerRows
1359 * Header rows for output.
1360 * @param array $sqlColumns
1362 * @param int $exportMode
1363 * Export mode ( contact, contribution, etc...).
1364 * @param string $componentTable
1365 * Name of temporary table
1367 * Array of object's ids
1371 public static function export(&$exportTempTable, &$headerRows, &$sqlColumns, $exportMode, $componentTable, $ids) {
1372 return self
::singleton()->invoke(['exportTempTable', 'headerRows', 'sqlColumns', 'exportMode', 'componentTable', 'ids'],
1373 $exportTempTable, $headerRows, $sqlColumns,
1374 $exportMode, $componentTable, $ids,
1380 * This hook allows modification of the queries constructed from dupe rules.
1382 * @param string $obj
1383 * Object of rulegroup class.
1384 * @param string $type
1385 * Type of queries e.g table / threshold.
1386 * @param array $query
1391 public static function dupeQuery($obj, $type, &$query) {
1392 return self
::singleton()->invoke(['obj', 'type', 'query'], $obj, $type, $query,
1393 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1399 * Check for duplicate contacts
1401 * @param array $dedupeParams
1402 * Array of params for finding duplicates: [
1403 * '{parameters returned by CRM_Dedupe_Finder::formatParams}
1404 * 'check_permission' => TRUE/FALSE;
1405 * 'contact_type' => $contactType;
1407 * 'rule_group_id' => $ruleGroupID;
1408 * 'excludedContactIDs' => $excludedContactIDs;
1409 * @param array $dedupeResults
1410 * Array of results ['handled' => TRUE/FALSE, 'ids' => array of IDs of duplicate contacts]
1411 * @param array $contextParams
1412 * The context if relevant, eg. ['event_id' => X]
1416 public static function findDuplicates($dedupeParams, &$dedupeResults, $contextParams) {
1417 return self
::singleton()
1418 ->invoke(['dedupeParams', 'dedupeResults', 'contextParams'], $dedupeParams, $dedupeResults, $contextParams, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_findDuplicates');
1422 * This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php
1424 * @param string $type
1425 * Type of mail processed: 'activity' OR 'mailing'.
1426 * @param array &$params the params that were sent to the CiviCRM API function
1427 * @param object $mail
1428 * The mail object which is an ezcMail class.
1429 * @param array &$result the result returned by the api call
1430 * @param string $action
1431 * (optional ) the requested action to be performed if the types was 'mailing'.
1435 public static function emailProcessor($type, &$params, $mail, &$result, $action = NULL) {
1436 return self
::singleton()
1437 ->invoke(['type', 'params', 'mail', 'result', 'action'], $type, $params, $mail, $result, $action, self
::$_nullObject, 'civicrm_emailProcessor');
1441 * This hook is called after a row has been processed and the
1442 * record (and associated records imported
1444 * @param string $object
1445 * Object being imported (for now Contact only, later Contribution, Activity,.
1446 * Participant and Member)
1447 * @param string $usage
1448 * Hook usage/location (for now process only, later mapping and others).
1449 * @param string $objectRef
1450 * Import record object.
1451 * @param array $params
1452 * Array with various key values: currently.
1453 * contactID - contact id
1454 * importID - row id in temp table
1455 * importTempTable - name of tempTable
1456 * fieldHeaders - field headers
1457 * fields - import fields
1461 public static function import($object, $usage, &$objectRef, &$params) {
1462 return self
::singleton()->invoke(['object', 'usage', 'objectRef', 'params'], $object, $usage, $objectRef, $params,
1463 self
::$_nullObject, self
::$_nullObject,
1469 * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
1470 * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).
1472 * @param string $entity
1473 * The API entity (like contact).
1474 * @param string $action
1475 * The API action (like get).
1476 * @param array &$params the API parameters
1477 * @param array &$permissions the associative permissions array (probably to be altered by this hook)
1481 public static function alterAPIPermissions($entity, $action, &$params, &$permissions) {
1482 return self
::singleton()->invoke(['entity', 'action', 'params', 'permissions'], $entity, $action, $params, $permissions,
1483 self
::$_nullObject, self
::$_nullObject,
1484 'civicrm_alterAPIPermissions'
1489 * @param CRM_Core_DAO $dao
1493 public static function postSave(&$dao) {
1494 $hookName = 'civicrm_postSave_' . $dao->getTableName();
1495 return self
::singleton()->invoke(['dao'], $dao,
1496 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1502 * This hook allows user to customize context menu Actions on contact summary page.
1504 * @param array $actions
1505 * Array of all Actions in contextmenu.
1506 * @param int $contactID
1507 * ContactID for the summary page.
1511 public static function summaryActions(&$actions, $contactID = NULL) {
1512 return self
::singleton()->invoke(['actions', 'contactID'], $actions, $contactID,
1513 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1514 'civicrm_summaryActions'
1519 * This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.
1520 * This enables us hook implementors to modify both the headers and the rows
1522 * The BIGGEST drawback with this hook is that you may need to modify the result template to include your
1523 * fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl
1525 * However, if you use the same number of columns, you can overwrite the existing columns with the values that
1526 * you want displayed. This is a hackish, but avoids template modification.
1528 * @param string $objectName
1529 * The component name that we are doing the search.
1530 * activity, campaign, case, contact, contribution, event, grant, membership, and pledge
1531 * @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
1532 * @param array &$rows the list of values, an associate array with fields that are displayed for that component
1533 * @param array $selector
1534 * the selector object. Allows you access to the context of the search
1537 * modify the header and values object to pass the data you need
1539 public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
1540 return self
::singleton()->invoke(['objectName', 'headers', 'rows', 'selector'], $objectName, $headers, $rows, $selector,
1541 self
::$_nullObject, self
::$_nullObject,
1542 'civicrm_searchColumns'
1547 * This hook is called when uf groups are being built for a module.
1549 * @param string $moduleName
1551 * @param array $ufGroups
1552 * Array of ufgroups for a module.
1556 public static function buildUFGroupsForModule($moduleName, &$ufGroups) {
1557 return self
::singleton()->invoke(['moduleName', 'ufGroups'], $moduleName, $ufGroups,
1558 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1559 'civicrm_buildUFGroupsForModule'
1564 * This hook is called when we are determining the contactID for a specific
1567 * @param string $email
1568 * The email address.
1569 * @param int $contactID
1570 * The contactID that matches this email address, IF it exists.
1571 * @param array $result
1572 * (reference) has two fields.
1573 * contactID - the new (or same) contactID
1574 * action - 3 possible values:
1575 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL - create a new contact record
1576 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE - use the new contactID
1577 * CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this email address
1581 public static function emailProcessorContact($email, $contactID, &$result) {
1582 return self
::singleton()->invoke(['email', 'contactID', 'result'], $email, $contactID, $result,
1583 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1584 'civicrm_emailProcessorContact'
1589 * Hook definition for altering the generation of Mailing Labels.
1591 * @param array $args
1592 * An array of the args in the order defined for the tcpdf multiCell api call.
1593 * with the variable names below converted into string keys (ie $w become 'w'
1594 * as the first key for $args)
1595 * float $w Width of cells. If 0, they extend up to the right margin of the page.
1596 * float $h Cell minimum height. The cell extends automatically if needed.
1597 * string $txt String to print
1598 * mixed $border Indicates if borders must be drawn around the cell block. The value can
1599 * be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or
1600 * a string containing some or all of the following characters (in any order):
1601 * <ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
1602 * string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string:
1603 * left align</li><li>C: center</li><li>R: right align</li><li>J: justification
1604 * (default value when $ishtml=false)</li></ul>
1605 * int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
1606 * int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0:
1607 * to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
1608 * float $x x position in user units
1609 * float $y y position in user units
1610 * boolean $reseth if true reset the last cell height (default true).
1611 * int $stretch stretch character mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if
1612 * necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if
1613 * necessary</li><li>4 = forced character spacing</li></ul>
1614 * boolean $ishtml set to true if $txt is HTML content (default = false).
1615 * boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
1616 * float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page,
1617 * or 0 for disable this feature. This feature works only when $ishtml=false.
1621 public static function alterMailingLabelParams(&$args) {
1622 return self
::singleton()->invoke(['args'], $args,
1623 self
::$_nullObject, self
::$_nullObject,
1624 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1625 'civicrm_alterMailingLabelParams'
1630 * This hooks allows alteration of generated page content.
1633 * Previously generated content.
1635 * Context of content - page or form.
1637 * The file name of the tpl.
1639 * A reference to the page or form object.
1643 public static function alterContent(&$content, $context, $tplName, &$object) {
1644 return self
::singleton()->invoke(['content', 'context', 'tplName', 'object'], $content, $context, $tplName, $object,
1645 self
::$_nullObject, self
::$_nullObject,
1646 'civicrm_alterContent'
1651 * This hooks allows alteration of the tpl file used to generate content. It differs from the
1652 * altercontent hook as the content has already been rendered through the tpl at that point
1655 * Previously generated content.
1657 * Reference to the form object.
1659 * Context of content - page or form.
1661 * Reference the file name of the tpl.
1665 public static function alterTemplateFile($formName, &$form, $context, &$tplName) {
1666 return self
::singleton()->invoke(['formName', 'form', 'context', 'tplName'], $formName, $form, $context, $tplName,
1667 self
::$_nullObject, self
::$_nullObject,
1668 'civicrm_alterTemplateFile'
1673 * This hook collects the trigger definition from all components.
1676 * @param string $tableName
1677 * (optional) the name of the table that we are interested in only.
1679 * @internal param \reference $triggerInfo to an array of trigger information
1680 * each element has 4 fields:
1681 * table - array of tableName
1682 * when - BEFORE or AFTER
1683 * event - array of eventName - INSERT OR UPDATE OR DELETE
1684 * sql - array of statements optionally terminated with a ;
1685 * a statement can use the tokes {tableName} and {eventName}
1686 * to do token replacement with the table / event. This allows
1687 * templatizing logging and other hooks
1690 public static function triggerInfo(&$info, $tableName = NULL) {
1691 return self
::singleton()->invoke(['info', 'tableName'], $info, $tableName,
1692 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1694 'civicrm_triggerInfo'
1699 * This hook allows changes to the spec of which tables to log.
1701 * @param array $logTableSpec
1705 public static function alterLogTables(&$logTableSpec) {
1706 return self
::singleton()->invoke(['logTableSpec'], $logTableSpec, $_nullObject,
1707 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1709 'civicrm_alterLogTables'
1714 * This hook is called when a module-extension is installed.
1715 * Each module will receive hook_civicrm_install during its own installation (but not during the
1716 * installation of unrelated modules).
1718 public static function install() {
1719 return self
::singleton()->invoke(0, self
::$_nullObject,
1720 self
::$_nullObject, self
::$_nullObject,
1721 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1727 * This hook is called when a module-extension is uninstalled.
1728 * Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the
1729 * uninstallation of unrelated modules).
1731 public static function uninstall() {
1732 return self
::singleton()->invoke(0, self
::$_nullObject,
1733 self
::$_nullObject, self
::$_nullObject,
1734 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1740 * This hook is called when a module-extension is re-enabled.
1741 * Each module will receive hook_civicrm_enable during its own re-enablement (but not during the
1742 * re-enablement of unrelated modules).
1744 public static function enable() {
1745 return self
::singleton()->invoke(0, self
::$_nullObject,
1746 self
::$_nullObject, self
::$_nullObject,
1747 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1753 * This hook is called when a module-extension is disabled.
1754 * Each module will receive hook_civicrm_disable during its own disablement (but not during the
1755 * disablement of unrelated modules).
1757 public static function disable() {
1758 return self
::singleton()->invoke(0, self
::$_nullObject,
1759 self
::$_nullObject, self
::$_nullObject,
1760 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1768 * This hook is called when the browser is being re-directed and allows the url
1771 * @param \Psr\Http\Message\UriInterface $url
1772 * @param array $context
1773 * Additional information about context
1774 * - output - if this is 'json' then it will return json.
1777 * the return value is ignored
1779 public static function alterRedirect(&$url, &$context) {
1780 return self
::singleton()->invoke(['url', 'context'], $url,
1781 $context, self
::$_nullObject,
1782 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1783 'civicrm_alterRedirect'
1794 public static function alterReportVar($varType, &$var, &$object) {
1795 return self
::singleton()->invoke(['varType', 'var', 'object'], $varType, $var, $object,
1797 self
::$_nullObject, self
::$_nullObject,
1798 'civicrm_alterReportVar'
1803 * This hook is called to drive database upgrades for extension-modules.
1806 * The type of operation being performed; 'check' or 'enqueue'.
1807 * @param CRM_Queue_Queue $queue
1808 * (for 'enqueue') the modifiable list of pending up upgrade tasks.
1811 * NULL, if $op is 'enqueue'.
1812 * TRUE, if $op is 'check' and upgrades are pending.
1813 * FALSE, if $op is 'check' and upgrades are not pending.
1815 public static function upgrade($op, CRM_Queue_Queue
$queue = NULL) {
1816 return self
::singleton()->invoke(['op', 'queue'], $op, $queue,
1817 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1824 * This hook is called when an email has been successfully sent by CiviCRM, but not on an error.
1826 * @param array $params
1827 * The mailing parameters. Array fields include: groupName, from, toName,
1828 * toEmail, subject, cc, bcc, text, html, returnPath, replyTo, headers,
1829 * attachments (array)
1833 public static function postEmailSend(&$params) {
1834 return self
::singleton()->invoke(['params'], $params,
1835 self
::$_nullObject, self
::$_nullObject,
1836 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1837 'civicrm_postEmailSend'
1842 * This hook is called when a CiviMail mailing has completed
1844 * @param int $mailingId
1849 public static function postMailing($mailingId) {
1850 return self
::singleton()->invoke(['mailingId'], $mailingId,
1851 self
::$_nullObject, self
::$_nullObject,
1852 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1853 'civicrm_postMailing'
1858 * This hook is called when Settings specifications are loaded.
1860 * @param array $settingsFolders
1861 * List of paths from which to derive metadata
1865 public static function alterSettingsFolders(&$settingsFolders) {
1866 return self
::singleton()->invoke(['settingsFolders'], $settingsFolders,
1867 self
::$_nullObject, self
::$_nullObject,
1868 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1869 'civicrm_alterSettingsFolders'
1874 * This hook is called when Settings have been loaded from the xml
1875 * It is an opportunity for hooks to alter the data
1877 * @param array $settingsMetaData
1878 * Settings Metadata.
1879 * @param int $domainID
1880 * @param mixed $profile
1884 public static function alterSettingsMetaData(&$settingsMetaData, $domainID, $profile) {
1885 return self
::singleton()->invoke(['settingsMetaData', 'domainID', 'profile'], $settingsMetaData,
1886 $domainID, $profile,
1887 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1888 'civicrm_alterSettingsMetaData'
1893 * This hook is called before running an api call.
1895 * @param API_Wrapper[] $wrappers
1896 * (see CRM_Utils_API_ReloadOption as an example)
1897 * @param mixed $apiRequest
1900 * The return value is ignored
1902 public static function apiWrappers(&$wrappers, $apiRequest) {
1903 return self
::singleton()
1904 ->invoke(['wrappers', 'apiRequest'], $wrappers, $apiRequest, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1905 self
::$_nullObject, 'civicrm_apiWrappers'
1910 * This hook is called before running pending cron jobs.
1912 * @param CRM_Core_JobManager $jobManager
1915 * The return value is ignored.
1917 public static function cron($jobManager) {
1918 return self
::singleton()->invoke(['jobManager'],
1919 $jobManager, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1925 * This hook is called when loading CMS permissions; use this hook to modify
1926 * the array of system permissions for CiviCRM.
1928 * @param array $permissions
1929 * Array of permissions. See CRM_Core_Permission::getCorePermissions() for
1930 * the format of this array.
1933 * The return value is ignored
1935 public static function permission(&$permissions) {
1936 return self
::singleton()->invoke(['permissions'], $permissions,
1937 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1938 'civicrm_permission'
1943 * This hook is called when checking permissions; use this hook to dynamically
1944 * escalate user permissions in certain use cases (cf. CRM-19256).
1946 * @param string $permission
1947 * The name of an atomic permission, ie. 'access deleted contacts'
1948 * @param bool $granted
1949 * Whether this permission is currently granted. The hook can change this value.
1950 * @param int $contactId
1951 * Contact whose permissions we are checking (if null, assume current user).
1954 * The return value is ignored
1956 public static function permission_check($permission, &$granted, $contactId) {
1957 return self
::singleton()->invoke(['permission', 'granted', 'contactId'], $permission, $granted, $contactId,
1958 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
1959 'civicrm_permission_check'
1964 * @param CRM_Core_Exception $exception
1965 * @param mixed $request
1966 * Reserved for future use.
1968 public static function unhandledException($exception, $request = NULL) {
1969 $event = new \Civi\Core\Event\
UnhandledExceptionEvent($exception, self
::$_nullObject);
1970 \Civi
::dispatcher()->dispatch('hook_civicrm_unhandled_exception', $event);
1974 * This hook is called for declaring managed entities via API.
1976 * Note: This is a pre-boot hook. It will dispatch via the extension/module
1977 * subsystem but *not* the Symfony EventDispatcher.
1979 * @param array[] $entityTypes
1980 * List of entity types; each entity-type is an array with keys:
1981 * - name: string, a unique short name (e.g. "ReportInstance")
1982 * - class: string, a PHP DAO class (e.g. "CRM_Report_DAO_Instance")
1983 * - table: string, a SQL table name (e.g. "civicrm_report_instance")
1984 * - fields_callback: array, list of callables which manipulates field list
1985 * - links_callback: array, list of callables which manipulates fk list
1988 * The return value is ignored
1990 public static function entityTypes(&$entityTypes) {
1991 return self
::singleton()->invoke(['entityTypes'], $entityTypes, self
::$_nullObject, self
::$_nullObject,
1992 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_entityTypes'
1997 * Build a description of available hooks.
1999 * @param \Civi\Core\CiviEventInspector $inspector
2001 public static function eventDefs($inspector) {
2002 $event = \Civi\Core\Event\GenericHookEvent
::create([
2003 'inspector' => $inspector,
2005 Civi
::dispatcher()->dispatch('hook_civicrm_eventDefs', $event);
2009 * This hook is called while preparing a profile form.
2011 * @param string $profileName
2014 public static function buildProfile($profileName) {
2015 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2016 self
::$_nullObject, self
::$_nullObject, 'civicrm_buildProfile');
2020 * This hook is called while validating a profile form submission.
2022 * @param string $profileName
2025 public static function validateProfile($profileName) {
2026 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2027 self
::$_nullObject, self
::$_nullObject, 'civicrm_validateProfile');
2031 * This hook is called processing a valid profile form submission.
2033 * @param string $profileName
2036 public static function processProfile($profileName) {
2037 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2038 self
::$_nullObject, self
::$_nullObject, 'civicrm_processProfile');
2042 * This hook is called while preparing a read-only profile screen
2044 * @param string $profileName
2047 public static function viewProfile($profileName) {
2048 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2049 self
::$_nullObject, self
::$_nullObject, 'civicrm_viewProfile');
2053 * This hook is called while preparing a list of contacts (based on a profile)
2055 * @param string $profileName
2058 public static function searchProfile($profileName) {
2059 return self
::singleton()->invoke(['profileName'], $profileName, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2060 self
::$_nullObject, self
::$_nullObject, 'civicrm_searchProfile');
2064 * This hook is invoked when building a CiviCRM name badge.
2066 * @param string $labelName
2067 * String referencing name of badge format.
2068 * @param object $label
2069 * Reference to the label object.
2070 * @param array $format
2071 * Array of format data.
2072 * @param array $participant
2073 * Array of participant values.
2076 * the return value is ignored
2078 public static function alterBadge($labelName, &$label, &$format, &$participant) {
2079 return self
::singleton()
2080 ->invoke(['labelName', 'label', 'format', 'participant'], $labelName, $label, $format, $participant, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBadge');
2084 * This hook is called before encoding data in barcode.
2086 * @param array $data
2087 * Associated array of values available for encoding.
2088 * @param string $type
2089 * Type of barcode, classic barcode or QRcode.
2090 * @param string $context
2091 * Where this hooks is invoked.
2095 public static function alterBarcode(&$data, $type = 'barcode', $context = 'name_badge') {
2096 return self
::singleton()->invoke(['data', 'type', 'context'], $data, $type, $context, self
::$_nullObject,
2097 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterBarcode');
2101 * Modify or replace the Mailer object used for outgoing mail.
2103 * @param object $mailer
2104 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2105 * @param string $driver
2106 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2107 * @param array $params
2108 * The default mailer config options
2111 * @see Mail::factory
2113 public static function alterMailer(&$mailer, $driver, $params) {
2114 return self
::singleton()
2115 ->invoke(['mailer', 'driver', 'params'], $mailer, $driver, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_alterMailer');
2119 * Deprecated: Misnamed version of alterMailer(). Remove post-4.7.x.
2120 * Modify or replace the Mailer object used for outgoing mail.
2122 * @param object $mailer
2123 * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
2124 * @param string $driver
2125 * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
2126 * @param array $params
2127 * The default mailer config options
2130 * @see Mail::factory
2133 public static function alterMail(&$mailer, $driver, $params) {
2134 // This has been deprecated on the premise it MIGHT be called externally for a long time.
2135 // We don't have a clear policy on how much we support external extensions calling internal
2136 // hooks (ie. in general we say 'don't call internal functions', but some hooks like pre hooks
2137 // are expected to be called externally.
2138 // It's really really unlikely anyone uses this - but let's add deprecations for a couple
2139 // of releases first.
2140 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Utils_Hook::alterMailer');
2141 return CRM_Utils_Hook
::alterMailer($mailer, $driver, $params);
2145 * This hook is called while building the core search query,
2146 * so hook implementers can provide their own query objects which alters/extends core search.
2148 * @param array $queryObjects
2149 * @param string $type
2153 public static function queryObjects(&$queryObjects, $type = 'Contact') {
2154 return self
::singleton()
2155 ->invoke(['queryObjects', 'type'], $queryObjects, $type, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_queryObjects');
2159 * This hook is called while viewing contact dashboard.
2161 * @param array $availableDashlets
2162 * List of dashlets; each is formatted per api/v3/Dashboard
2163 * @param array $defaultDashlets
2164 * List of dashlets; each is formatted per api/v3/DashboardContact
2168 public static function dashboard_defaults($availableDashlets, &$defaultDashlets) {
2169 return self
::singleton()
2170 ->invoke(['availableDashlets', 'defaultDashlets'], $availableDashlets, $defaultDashlets, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_dashboard_defaults');
2174 * This hook is called before a case merge (or a case reassign)
2176 * @param int $mainContactId
2177 * @param int $mainCaseId
2178 * @param int $otherContactId
2179 * @param int $otherCaseId
2180 * @param bool $changeClient
2184 public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2185 return self
::singleton()
2186 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_pre_case_merge');
2190 * This hook is called after a case merge (or a case reassign)
2192 * @param int $mainContactId
2193 * @param int $mainCaseId
2194 * @param int $otherContactId
2195 * @param int $otherCaseId
2196 * @param bool $changeClient
2200 public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
2201 return self
::singleton()
2202 ->invoke(['mainContactId', 'mainCaseId', 'otherContactId', 'otherCaseId', 'changeClient'], $mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient, self
::$_nullObject, 'civicrm_post_case_merge');
2207 * Add a hook for altering the display name
2209 * hook_civicrm_contact_get_displayname(&$display_name, $objContact)
2211 * @param string $displayName
2212 * @param int $contactId
2213 * @param object $dao
2214 * The contact object.
2218 public static function alterDisplayName(&$displayName, $contactId, $dao) {
2219 return self
::singleton()->invoke(['displayName', 'contactId', 'dao'],
2220 $displayName, $contactId, $dao, self
::$_nullObject, self
::$_nullObject,
2221 self
::$_nullObject, 'civicrm_contact_get_displayname'
2226 * Modify the CRM_Core_Resources settings data.
2228 * @param array $data
2229 * @see CRM_Core_Resources::addSetting
2231 public static function alterResourceSettings(&$data) {
2232 $event = \Civi\Core\Event\GenericHookEvent
::create([
2235 Civi
::dispatcher()->dispatch('hook_civicrm_alterResourceSettings', $event);
2239 * EXPERIMENTAL: This hook allows one to register additional Angular modules
2241 * @param array $angularModules
2242 * List of modules. Each module defines:
2243 * - ext: string, the CiviCRM extension which hosts the files.
2244 * - js: array, list of JS files or globs.
2245 * - css: array, list of CSS files or globs.
2246 * - partials: array, list of base-dirs containing HTML.
2247 * - requires: array, list of required Angular modules.
2248 * - basePages: array, uncondtionally load this module onto the given Angular pages. [v4.7.21+]
2249 * If omitted, default to "array('civicrm/a')" for backward compat.
2250 * For a utility that should only be loaded on-demand, use "array()".
2251 * For a utility that should be loaded in all pages use, "array('*')".
2253 * the return value is ignored
2256 * function mymod_civicrm_angularModules(&$angularModules) {
2257 * $angularModules['myAngularModule'] = array(
2258 * 'ext' => 'org.example.mymod',
2259 * 'js' => array('js/myAngularModule.js'),
2261 * $angularModules['myBigAngularModule'] = array(
2262 * 'ext' => 'org.example.mymod',
2263 * 'js' => array('js/part1.js', 'js/part2.js', 'ext://other.ext.name/file.js', 'assetBuilder://dynamicAsset.js'),
2264 * 'css' => array('css/myAngularModule.css', 'ext://other.ext.name/file.css', 'assetBuilder://dynamicAsset.css'),
2265 * 'partials' => array('partials/myBigAngularModule'),
2266 * 'requires' => array('otherModuleA', 'otherModuleB'),
2267 * 'basePages' => array('civicrm/a'),
2272 public static function angularModules(&$angularModules) {
2273 return self
::singleton()->invoke(['angularModules'], $angularModules,
2274 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2275 'civicrm_angularModules'
2280 * Alter the definition of some Angular HTML partials.
2282 * @param \Civi\Angular\Manager $angular
2285 * function example_civicrm_alterAngular($angular) {
2286 * $changeSet = \Civi\Angular\ChangeSet::create('mychanges')
2287 * ->alterHtml('~/crmMailing/EditMailingCtrl/2step.html', function(phpQueryObject $doc) {
2288 * $doc->find('[ng-form="crmMailingSubform"]')->attr('cat-stevens', 'ts(\'wild world\')');
2291 * $angular->add($changeSet);
2295 public static function alterAngular($angular) {
2296 $event = \Civi\Core\Event\GenericHookEvent
::create([
2297 'angular' => $angular,
2299 Civi
::dispatcher()->dispatch('hook_civicrm_alterAngular', $event);
2303 * This hook is called when building a link to a semi-static asset.
2305 * @param string $asset
2306 * The name of the asset.
2307 * Ex: 'angular.json'
2308 * @param array $params
2309 * List of optional arguments which influence the content.
2311 * the return value is ignored
2313 public static function getAssetUrl(&$asset, &$params) {
2314 return self
::singleton()->invoke(['asset', 'params'],
2315 $asset, $params, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2316 'civicrm_getAssetUrl'
2321 * This hook is called whenever the system builds a new copy of
2322 * semi-static asset.
2324 * @param string $asset
2325 * The name of the asset.
2326 * Ex: 'angular.json'
2327 * @param array $params
2328 * List of optional arguments which influence the content.
2329 * Note: Params are immutable because they are part of the cache-key.
2330 * @param string $mimeType
2331 * Initially, NULL. Modify to specify the mime-type.
2332 * @param string $content
2333 * Initially, NULL. Modify to specify the rendered content.
2335 * the return value is ignored
2337 public static function buildAsset($asset, $params, &$mimeType, &$content) {
2338 return self
::singleton()->invoke(['asset', 'params', 'mimeType', 'content'],
2339 $asset, $params, $mimeType, $content, self
::$_nullObject, self
::$_nullObject,
2340 'civicrm_buildAsset'
2345 * This hook fires whenever a record in a case changes.
2347 * @param \Civi\CCase\Analyzer $analyzer
2348 * A bundle of data about the case (such as the case and activity records).
2350 public static function caseChange(\Civi\CCase\Analyzer
$analyzer) {
2351 $event = new \Civi\CCase\Event\
CaseChangeEvent($analyzer);
2352 \Civi
::dispatcher()->dispatch('hook_civicrm_caseChange', $event);
2356 * Generate a default CRUD URL for an entity.
2358 * @param array $spec
2360 * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
2361 * - entity_table: string
2363 * @param CRM_Core_DAO $bao
2364 * @param array $link
2365 * To define the link, add these keys to $link:.
2369 * - url: string (used in lieu of "path"/"query")
2370 * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
2373 public static function crudLink($spec, $bao, &$link) {
2374 return self
::singleton()->invoke(['spec', 'bao', 'link'], $spec, $bao, $link,
2375 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2381 * Modify the CiviCRM container - add new services, parameters, extensions, etc.
2384 * use Symfony\Component\Config\Resource\FileResource;
2385 * use Symfony\Component\DependencyInjection\Definition;
2387 * function mymodule_civicrm_container($container) {
2388 * $container->addResource(new FileResource(__FILE__));
2389 * $container->setDefinition('mysvc', new Definition('My\Class', array()));
2393 * Tip: The container configuration will be compiled/cached. The default cache
2394 * behavior is aggressive. When you first implement the hook, be sure to
2395 * flush the cache. Additionally, you should relax caching during development.
2396 * In `civicrm.settings.php`, set define('CIVICRM_CONTAINER_CACHE', 'auto').
2398 * Note: This is a preboot hook. It will dispatch via the extension/module
2399 * subsystem but *not* the Symfony EventDispatcher.
2401 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
2402 * @see http://symfony.com/doc/current/components/dependency_injection/index.html
2404 public static function container(\Symfony\Component\DependencyInjection\ContainerBuilder
$container) {
2405 self
::singleton()->invoke(['container'], $container, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_container');
2409 * @param array $fileSearches CRM_Core_FileSearchInterface
2412 public static function fileSearches(&$fileSearches) {
2413 return self
::singleton()->invoke(['fileSearches'], $fileSearches,
2414 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2415 'civicrm_fileSearches'
2420 * Check system status.
2422 * @param array $messages
2423 * Array<CRM_Utils_Check_Message>. A list of messages regarding system status.
2426 public static function check(&$messages) {
2427 return self
::singleton()
2428 ->invoke(['messages'], $messages, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_check');
2432 * This hook is called when a query string of the CSV Batch export is generated.
2434 * @param string $query
2438 public static function batchQuery(&$query) {
2439 return self
::singleton()->invoke(['query'], $query, self
::$_nullObject,
2440 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2441 'civicrm_batchQuery'
2446 * This hook is called to alter Deferred revenue item values just before they are
2447 * inserted in civicrm_financial_trxn table
2449 * @param array $deferredRevenues
2451 * @param array $contributionDetails
2453 * @param bool $update
2455 * @param string $context
2459 public static function alterDeferredRevenueItems(&$deferredRevenues, $contributionDetails, $update, $context) {
2460 return self
::singleton()->invoke(['deferredRevenues', 'contributionDetails', 'update', 'context'], $deferredRevenues, $contributionDetails, $update, $context,
2461 self
::$_nullObject, self
::$_nullObject, 'civicrm_alterDeferredRevenueItems'
2466 * This hook is called when the entries of the CSV Batch export are mapped.
2468 * @param array $results
2469 * @param array $items
2473 public static function batchItems(&$results, &$items) {
2474 return self
::singleton()->invoke(['results', 'items'], $results, $items,
2475 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2476 'civicrm_batchItems'
2481 * This hook is called when core resources are being loaded
2483 * @see CRM_Core_Resources::coreResourceList
2485 * @param array $list
2486 * @param string $region
2488 public static function coreResourceList(&$list, $region) {
2489 self
::singleton()->invoke(['list', 'region'], $list, $region,
2490 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2491 'civicrm_coreResourceList'
2496 * Allows the list of filters on the EntityRef widget to be altered.
2498 * @see CRM_Core_Resources::entityRefFilters
2500 * @param array $filters
2501 * @param array $links
2503 public static function entityRefFilters(&$filters, &$links = NULL) {
2504 self
::singleton()->invoke(['filters', 'links'], $filters, $links, self
::$_nullObject,
2505 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2506 'civicrm_entityRefFilters'
2511 * This hook is called for bypass a few civicrm urls from IDS check.
2513 * @param array $skip list of civicrm urls
2517 public static function idsException(&$skip) {
2518 return self
::singleton()->invoke(['skip'], $skip, self
::$_nullObject,
2519 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2520 'civicrm_idsException'
2525 * This hook is called when a geocoder's format method is called.
2527 * @param string $geoProvider
2528 * @param array $values
2529 * @param SimpleXMLElement $xml
2533 public static function geocoderFormat($geoProvider, &$values, $xml) {
2534 return self
::singleton()->invoke(['geoProvider', 'values', 'xml'], $geoProvider, $values, $xml,
2535 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2536 'civicrm_geocoderFormat'
2541 * This hook is called before an inbound SMS is processed.
2543 * @param \CRM_SMS_Message $message
2544 * An SMS message received
2547 public static function inboundSMS(&$message) {
2548 return self
::singleton()->invoke(['message'], $message, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, 'civicrm_inboundSMS');
2552 * This hook is called to modify api params of EntityRef form field
2554 * @param array $params
2555 * @param string $formName
2558 public static function alterEntityRefParams(&$params, $formName) {
2559 return self
::singleton()->invoke(['params', 'formName'], $params, $formName,
2560 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2561 'civicrm_alterEntityRefParams'
2566 * This hook is called before a scheduled job is executed
2568 * @param CRM_Core_DAO_Job $job
2569 * The job to be executed
2570 * @param array $params
2571 * The arguments to be given to the job
2573 public static function preJob($job, $params) {
2574 return self
::singleton()->invoke(['job', 'params'], $job, $params,
2575 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2581 * This hook is called after a scheduled job is executed
2583 * @param CRM_Core_DAO_Job $job
2584 * The job that was executed
2585 * @param array $params
2586 * The arguments given to the job
2587 * @param array $result
2588 * The result of the API call, or the thrown exception if any
2590 public static function postJob($job, $params, $result) {
2591 return self
::singleton()->invoke(['job', 'params', 'result'], $job, $params, $result,
2592 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2598 * This hook is called before and after constructing mail recipients.
2599 * Allows user to alter filter and/or search query to fetch mail recipients
2601 * @param CRM_Mailing_DAO_Mailing $mailingObject
2602 * @param array $criteria
2603 * A list of SQL criteria; you can add/remove/replace/modify criteria.
2604 * Array(string $name => CRM_Utils_SQL_Select $criterion).
2605 * Ex: array('do_not_email' => CRM_Utils_SQL_Select::fragment()->where("$contact.do_not_email = 0")).
2606 * @param string $context
2610 public static function alterMailingRecipients(&$mailingObject, &$criteria, $context) {
2611 return self
::singleton()->invoke(['mailingObject', 'params', 'context'],
2612 $mailingObject, $criteria, $context,
2613 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2614 'civicrm_alterMailingRecipients'
2619 * ALlow Extensions to custom process IPN hook data such as sending Google Analyitcs information based on the IPN
2620 * @param array $IPNData - Array of IPN Data
2623 public static function postIPNProcess(&$IPNData) {
2624 return self
::singleton()->invoke(['IPNData'],
2625 $IPNData, self
::$_nullObject, self
::$_nullObject,
2626 self
::$_nullObject, self
::$_nullObject, self
::$_nullObject,
2627 'civicrm_postIPNProcess'