CRM_Utils_Hook_Joomla

Constructor and getter for the singleton instance.

CRM_Utils_Hook constructor.

Invoke a hook.

This is a transitional adapter. It supports the legacy syntax but also accepts enough information to support Symfony Event dispatching.

Build the list of modules to be processed for hooks.

Run hooks.

This hook is called before a db write on some core objects.

This hook does not allow the abort of the operation

This hook is called after a db write on some core objects.

This hook retrieves links from other modules and injects it into.

the view contact tabs

This hook is invoked during the CiviCRM form preProcess phase.

This hook is invoked when building a CiviCRM form. This hook should also be used to set the default values of a form element

This hook is invoked when a CiviCRM form is submitted. If the module has injected any form elements, this hook should save the values in the database

This hook is invoked during all CiviCRM form validation. An array of errors detected is returned. Else we assume validation succeeded.

This hook is called after a db write on a custom table.

This hook is called when composing the ACL where clause to restrict visibility of contacts to the logged in user

This hook is called when composing the ACL where clause to restrict visibility of contacts to the logged in user

This hook is called when building the menu table.

(Experimental) This hook is called when build the menu table.

A theme is a set of CSS files which are loaded on CiviCRM pages. To register a new theme, add it to the $themes array. Use these properties:

• ext: string (required) The full name of the extension which defines the theme. Ex: "org.civicrm.themes.greenwich".
  • title: string (required) Visible title.
  • help: string (optional) Description of the theme's appearance.
  • url_callback: mixed (optional) A function ($themes, $themeKey, $cssExt, $cssFile) which returns the URL(s) for a CSS resource. Returns either an array of URLs or PASSTHRU. Ex: \Civi\Core\Themes\Resolvers::simple (default) Ex: \Civi\Core\Themes\Resolvers::none
  • prefix: string (optional) A prefix within the extension folder to prepend to the file name.
  • search_order: array (optional) A list of themes to search. Generally, the last theme should be "fallback" (Civi\Core\Themes::FALLBACK).
  • excludes: array (optional) A list of files (eg "civicrm:css/bootstrap.css" or "$ext:$file") which should never be returned (they are excluded from display).

The activeTheme hook determines which theme is active.

This hook is called for declaring managed entities via API.

This hook is called when rendering the dashboard (q=civicrm/dashboard)

This hook is called before storing recently viewed items.

Determine how many other records refer to a given record.

This hook is called when building the amount structure for a Contribution or Event Page.

This hook is called when building the state list for a particular country.

This hook is called when rendering the tabs for a contact (q=civicrm/contact/view)c

This hook is called when rendering the tabs used for events and potentially contribution pages, etc.

This hook is called when sending an email / printing labels

This hook allows modification of the admin panels

This hook is called when sending an email / printing labels to get the values for all the tokens returned by the 'tokens' hook

This hook is called before a CiviCRM Page is rendered. You can use this hook to insert smarty variables in a template

This hook is called after a copy of an object has been made. The current objects are Event, Contribution Page and UFGroup

This hook is called when a contact unsubscribes from a mailing. It allows modules to override what the contacts are removed from.

This hook is called when CiviCRM needs to edit/display a custom field with options

Hook for modifying field options

This hook is called to display the list of actions allowed after doing a search.

This allows the module developer to inject additional actions or to remove existing actions.

This hook is called when composing a mailing. You can include / exclude other groups as needed.

(Experimental) Modify the list of template-types used for CiviMail composition.

This hook is called when composing the array of membershipTypes and their cost during a membership registration (new or renewal).

Note the hook is called on initial page load and also reloaded after submit (PRG pattern). You can use it to alter the membership types when first loaded, or after submission (for example if you want to gather data in the form and use it to alter the fees).

This hook is called when rendering the contact summary.

Use this hook to populate the list of contacts returned by Contact Reference custom fields.

By default, Contact Reference fields will search on and return all CiviCRM contacts. If you want to limit the contacts returned to a specific group, or some other criteria - you can override that behavior by providing a SQL query that returns some subset of your contacts. The hook is called when the query is executed to get the list of contacts to display.

Hook definition for altering payment parameters before talking to a payment processor back end.

Definition will look like this:

function hook_civicrm_alterPaymentProcessorParams( $paymentObj, &$rawParams, &$cookedParams );

This hook is called when an email is about to be sent by CiviCRM.

This hook is called when membership status is being calculated.

This hook is called after getting the content of the mail and before tokenizing it.

This hook is called when rendering the Manage Case screen.

This hook is called when locating CiviCase types.

This hook is called soon after the CRM_Core_Config object has ben initialized.

You can use this hook to modify the config object and hence behavior of CiviCRM dynamically.

This hooks allows to change option values.

This hook allows modification of the navigation menu.

This hook allows modification of the data used to perform merging of duplicates.

This hook allows modification of the data calculated for merging locations.

This hook provides a way to override the default privacy behavior for notes.

This hook is called before record is exported as CSV.

This hook allows modification of the queries constructed from dupe rules.

Check for duplicate contacts

This hook is called AFTER EACH email has been processed by the script bin/EmailProcessor.php

This hook is called after a row has been processed and the record (and associated records imported

This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission() in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/permissions.php).

This hook allows user to customize context menu Actions on contact summary page.

This hook is called from CRM_Core_Selector_Controller through which all searches in civicrm go.

This enables us hook implementors to modify both the headers and the rows

The BIGGEST drawback with this hook is that you may need to modify the result template to include your fields. The result files are CRM/{Contact,Contribute,Member,Event...}/Form/Selector.tpl

However, if you use the same number of columns, you can overwrite the existing columns with the values that you want displayed. This is a hackish, but avoids template modification.

This hook is called when uf groups are being built for a module.

This hook is called when we are determining the contactID for a specific email address

Hook definition for altering the generation of Mailing Labels.

This hooks allows alteration of generated page content.

This hooks allows alteration of the tpl file used to generate content. It differs from the altercontent hook as the content has already been rendered through the tpl at that point

This hook collects the trigger definition from all components.

This hook allows changes to the spec of which tables to log.

This hook is called when a module-extension is installed.

Each module will receive hook_civicrm_install during its own installation (but not during the installation of unrelated modules).

This hook is called when a module-extension is uninstalled.

Each module will receive hook_civicrm_uninstall during its own uninstallation (but not during the uninstallation of unrelated modules).

This hook is called when a module-extension is re-enabled.

Each module will receive hook_civicrm_enable during its own re-enablement (but not during the re-enablement of unrelated modules).

This hook is called when a module-extension is disabled.

Each module will receive hook_civicrm_disable during its own disablement (but not during the disablement of unrelated modules).

Alter redirect.

This hook is called when the browser is being re-directed and allows the url to be altered.

This hook is called to drive database upgrades for extension-modules.

This hook is called when an email has been successfully sent by CiviCRM, but not on an error.

This hook is called when a CiviMail mailing has completed

This hook is called when Settings specifications are loaded.

This hook is called when Settings have been loaded from the xml It is an opportunity for hooks to alter the data

This hook is called before running an api call.

This hook is called before running pending cron jobs.

This hook is called when loading CMS permissions; use this hook to modify the array of system permissions for CiviCRM.

This hook is called when checking permissions; use this hook to dynamically escalate user permissions in certain use cases (cf. CRM-19256).

This hook is called for declaring managed entities via API.

Note: This is a pre-boot hook. It will dispatch via the extension/module subsystem but not the Symfony EventDispatcher.

Build a description of available hooks.

This hook is called while preparing a profile form.

This hook is called while validating a profile form submission.

This hook is called processing a valid profile form submission.

This hook is called while preparing a read-only profile screen

This hook is called while preparing a list of contacts (based on a profile)

This hook is invoked when building a CiviCRM name badge.

This hook is called before encoding data in barcode.

Modify or replace the Mailer object used for outgoing mail.

Deprecated: Misnamed version of alterMailer(). Remove post-4.7.x.

Modify or replace the Mailer object used for outgoing mail.

This hook is called while building the core search query, so hook implementers can provide their own query objects which alters/extends core search.

This hook is called while viewing contact dashboard.

This hook is called before a case merge (or a case reassign)

This hook is called after a case merge (or a case reassign)

Issue CRM-14276 Add a hook for altering the display name

hook_civicrm_contact_get_displayname(&$display_name, $objContact)

Modify the CRM_Core_Resources settings data.

EXPERIMENTAL: This hook allows one to register additional Angular modules

Alter the definition of some Angular HTML partials.

This hook is called when building a link to a semi-static asset.

This hook is called whenever the system builds a new copy of semi-static asset.

This hook fires whenever a record in a case changes.

Generate a default CRUD URL for an entity.

Modify the CiviCRM container - add new services, parameters, extensions, etc.

Check system status.

This hook is called when a query string of the CSV Batch export is generated.

This hook is called to alter Deferred revenue item values just before they are inserted in civicrm_financial_trxn table

This hook is called when the entries of the CSV Batch export are mapped.

This hook is called when core resources are being loaded

Allows the list of filters on the EntityRef widget to be altered.

This hook is called for bypass a few civicrm urls from IDS check.

This hook is called when a geocoder's format method is called.

This hook is called before an inbound SMS is processed.

This hook is called to modify api params of EntityRef form field

This hook is called before a scheduled job is executed

This hook is called after a scheduled job is executed

This hook is called before and after constructing mail recipients.

Allows user to alter filter and/or search query to fetch mail recipients

ALlow Extensions to custom process IPN hook data such as sending Google Analyitcs information based on the IPN