Hooks
Allow modules to interact with the Drupal core.
Drupal's module system is based on the concept of "hooks". A hook is a PHP function that is named foo_bar(), where "foo" is the name of the module (whose filename is thus foo.module) and "bar" is the name of the hook. Each hook has a defined set of parameters and a specified result type.
To extend Drupal, a module need simply implement a hook. When Drupal wishes to allow intervention from modules, it determines which modules implement a hook and call that hook in all enabled modules that implement it.
The available hooks to implement are explained here in the Hooks section of the developer documentation. The string "hook" is used as a placeholder for the module name is the hook definitions. For example, if the module file is called example.module, then hook_help() as implemented by that module would be defined as example_help().
Functions
Name | Location | Description |
|---|---|---|
| custom_url_rewrite | docs-5/hooks/core.php | custom_url_rewrite is not a hook. It is a function you can add to settings.php to manage aliases with some code. |
| hook_access | docs-5/hooks/node.php | Define access restrictions. |
| hook_allocation_info | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Register allocation types to the receipt system. An allocation is literally an allocation of some money on a receipt (say from a payment gateway) against a transaction. |
| hook_alloc_allocation | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | tba (example is from store.module) |
| hook_alloc_build_items | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | tba (example is from store.module) |
| hook_alloc_get_address | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | The allocation object provider returns an appropriate address. Eg. store returns an address from the transaction object. |
| hook_alloc_get_currency | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | The allocation object provider returns currency. Eg. store returns the currency of the transaction object. |
| hook_alloc_get_customer | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | The allocation object provider returns the customer. Eg. store returns the customer from the transaction object. |
| hook_alloc_get_customer_names | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | The allocation object provider customer names from an allocation object. Eg. store returns the customers from the transaction object. |
| hook_alloc_get_invoice_no | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | The allocation object provider returns the invoice number of the allocation object. Eg. store returns the invoice number from the transaction object. |
| hook_alloc_get_items | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | The allocation object provider returns the items of the allocation object. Eg. store returns the product items from the transaction object. |
| hook_alloc_get_payment_data | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Return the payment data of an allocation object. Eg. store returns the data previously assigned in 'set_payment_data' |
| hook_alloc_get_payment_form | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | I have no idea how an allocation provide returns a payment form since its not a receipt type - sime |
| hook_alloc_get_payment_type | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Return the payment method of an allocation object. Eg. store returns the method assigned in 'set_payment_data' |
| hook_alloc_get_total | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Return the total amount for an allocation object. Eg. store returns the total for a transaction. |
| hook_alloc_load | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Load an allocation object. Eg. store returns the total for a transaction. |
| hook_alloc_set_payment_data | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Allows an allocation object provider to assign payment data to its native object. Eg. store assigns payment data to its transaction. |
| hook_block | docs-5/hooks/core.php | Declare a block or set of blocks. |
| hook_checkoutapi | ecommerce-5--4/docs/developer/hooks/ec_checkout.php | Manipulate the checkout process, including injecting form pages. |
| hook_comment | docs-5/hooks/core.php | Act on comments. |
| hook_cron | docs-5/hooks/core.php | Perform periodic actions. |
| hook_customer_get_id | ecommerce-5--4/docs/developer/hooks/ec_customer.php | Return a customer which your Customer Type module handles. This may be a customer which e-Commerce has never seen before so you're looking in your external location. |
| hook_customer_info | ecommerce-5--4/docs/developer/hooks/ec_customer.php | General description. |
| hook_db_rewrite_sql | docs-5/hooks/core.php | Add JOIN and WHERE statements to queries and decide whether the primary_field shall be made DISTINCT. For node objects, primary field is always called nid. For taxonomy terms, it is tid and for vocabularies it is vid. For comments, it is cid. Primary... |
| hook_delete | docs-5/hooks/node.php | Respond to node deletion. |
| hook_disable | docs-5/hooks/install.php | Perform necessary actions before module is disabled. |
| hook_elements | docs-5/hooks/core.php | Allows modules to declare their own form element types and specify their default values. |
| hook_enable | docs-5/hooks/install.php | Perform necessary actions after module is enabled. |
| hook_exit | docs-5/hooks/core.php | Perform cleanup tasks. |
| hook_field | cck-5--1/field.php | Define the behavior of a field type. |
| hook_field_formatter | cck-5--1/field.php | Prepare an individual item for viewing in a browser. |
| hook_field_formatter_info | cck-5--1/field.php | Declare information about a formatter. |
| hook_field_info | cck-5--1/field.php | Declare information about a field type. |
| hook_field_settings | cck-5--1/field.php | Handle the parameters for a field. |
| hook_file_download | docs-5/hooks/core.php | Allow file downloads. |
| hook_filter | docs-5/hooks/core.php | Define content filters. |
| hook_filter_tips | docs-5/hooks/core.php | Provide tips for using filters. |
| hook_footer | docs-5/hooks/core.php | Insert closing HTML. |
| hook_form | docs-5/hooks/node.php | Display a node editing form. |
| hook_forms | docs-5/hooks/core.php | Map form_ids to builder functions. |
| hook_form_alter | docs-5/hooks/core.php | Perform alterations before a form is rendered. |
| hook_help | docs-5/hooks/core.php | Provide online user help. |
| hook_init | docs-5/hooks/core.php | Perform setup tasks. |
| hook_insert | docs-5/hooks/node.php | Respond to node insertion. |
| hook_install | docs-5/hooks/install.php | Install the current version of the database schema. |
| hook_link | docs-5/hooks/core.php | Define internal Drupal links. |
| hook_link_alter | docs-5/hooks/core.php | Perform alterations before links on a node are rendered. One popular use of this hook is to add/delete links from other modules. |
| hook_load | docs-5/hooks/node.php | Load node-type-specific information. |
| hook_mail_alter | docs-5/hooks/core.php | Alter any aspect of the emails sent by Drupal. You can use this hook to add a common site footer to all outgoing emails; add extra header fields and/or modify the mails sent out in any way. HTML-izing the outgoing mails is one possibility. See also... |
| hook_menu | docs-5/hooks/core.php | Define menu items and page callbacks. |
| hook_nodeapi | docs-5/hooks/core.php | Act on nodes defined by other modules. |
| hook_node_access_records | docs-5/hooks/core.php | Set permissions for a node to be written to the database. |
| hook_node_grants | docs-5/hooks/core.php | Inform the node access system what permissions the user has. |
| hook_node_info | docs-5/hooks/node.php | Define module-provided node types. |
| hook_node_operations | docs-5/hooks/core.php | Add mass node operations. |
| hook_node_type | docs-5/hooks/node.php | Act on node type changes. |
| hook_perm | docs-5/hooks/core.php | Define user permissions. |
| hook_ping | docs-5/hooks/core.php | Ping another server. |
| hook_prepare | docs-5/hooks/node.php | This is a hook used by node modules. It is called after load but before the node is shown on the add/edit form. |
| hook_profile_alter | docs-5/hooks/core.php | Perform alterations profile items before they are rendered. You may omit/add/re-sort/re-categorize, etc. |
| hook_receipt_info | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Register payments gateways to the e-Commerce Receipts system |
| hook_receipt_load | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Load additional receipt information from the database. |
| hook_receipt_payment_form | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Build a form for collecting the payment information. |
| hook_receipt_payment_url | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | |
| hook_receipt_process_payment | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Using the information past from the payment form the system will process the payment and update the receipt. |
| hook_receipt_save | ecommerce-5--4/docs/developer/hooks/ec_receipt.php | Save additional information about the receipt to the database. |
| hook_requirements | docs-5/hooks/install.php | Check installation requirements that need to be satisfied. |
| hook_search | docs-5/hooks/core.php | Define a custom search routine. |
| hook_search_preprocess | docs-5/hooks/core.php | Preprocess text for the search index. |
| hook_submit | docs-5/hooks/node.php | This is a hook used by node modules. It is called after validation has succeeded and before insert/update. It is used to for actions which must happen only if the node is to be saved. Usually, $node is changed in some way and then the actual saving of... |
| hook_taxonomy | docs-5/hooks/core.php | Act on taxonomy changes. |
| hook_uninstall | docs-5/hooks/install.php | Remove any tables or variables that the module sets. |
| hook_update | docs-5/hooks/node.php | Respond to node updating. |
| hook_update_index | docs-5/hooks/core.php | Update Drupal's full-text index for this module. |
| hook_update_N | docs-5/hooks/install.php | Perform a single update. For each patch which requires a database change add a new hook_update_N() which will be called by update.php. |
| hook_user | docs-5/hooks/core.php | Act on user account actions. |
| hook_user_operations | docs-5/hooks/core.php | Add mass user operations. |
| hook_validate | docs-5/hooks/node.php | Verify a node editing form. |
| hook_view | docs-5/hooks/node.php | Display a node. |
| hook_widget | cck-5--1/field.php | Define the behavior of a widget. |
| hook_widget_info | cck-5--1/field.php | Declare information about a widget. |
| hook_widget_settings | cck-5--1/field.php | Handle the parameters for a widget. |
| hook_xmlrpc | docs-5/hooks/core.php | Register XML-RPC callbacks. |
| hook_xyz | ecommerce-5--4/docs/developer/hooks/ec_customer.php | General description. |
| module_hook | drupal-5/includes/module.inc | Determine whether a module implements a hook. |
| module_implements | drupal-5/includes/module.inc | Determine which modules are implementing a hook. |
| module_invoke | drupal-5/includes/module.inc | Invoke a hook in a particular module. |
| module_invoke_all | drupal-5/includes/module.inc | Invoke a hook in all enabled modules that implement it. |