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_inbound	docs/docs/developer/hooks/core.php	custom_url_rewrite_inbound is not a hook, it's a function you can add to settings.php to alter incoming requests so they map to a Drupal path. This function is called before modules are loaded and the menu system is initialized and it changes...
custom_url_rewrite_outbound	docs/docs/developer/hooks/core.php	custom_url_rewrite_outbound is not a hook, it's a function you can add to settings.php to alter all links generated by Drupal. This function is called from url(). This function is called very frequently (100+ times per page) so performance...
hook_access	docs/docs/developer/hooks/node.php	Define access restrictions.
hook_actions_delete	docs/docs/developer/hooks/core.php	Execute code after an action is deleted.
hook_action_info	docs/docs/developer/hooks/core.php	Declare information about one or more Drupal actions.
hook_action_info_alter	docs/docs/developer/hooks/core.php	Alter the actions declared by another module.
hook_add_to_cart	ubercart/docs/hooks.php	Do extra processing when an item is added to the shopping cart.
hook_add_to_cart_data	ubercart/docs/hooks.php	Add extra information to a cart item's "data" array.
hook_block	docs/docs/developer/hooks/core.php	Declare a block or set of blocks.
hook_boot	docs/docs/developer/hooks/core.php	Perform setup tasks. See also, hook_init.
hook_calculate_tax	ubercart/docs/hooks.php	Calculate tax line items for an order.
hook_cart_display	ubercart/docs/hooks.php	Control the display of an item in the cart.
hook_cart_item	ubercart/docs/hooks.php	Add extra data about an item in the cart.
hook_cart_pane	ubercart/docs/hooks.php	Register callbacks for a cart pane.
hook_checkout_pane	ubercart/docs/hooks.php	Register callbacks for a checkout pane.
hook_comment	docs/docs/developer/hooks/core.php	Act on comments.
hook_cron	docs/docs/developer/hooks/core.php	Perform periodic actions.
hook_db_rewrite_sql	docs/docs/developer/hooks/core.php	Rewrite database queries, usually for access control.
hook_delete	docs/docs/developer/hooks/node.php	Respond to node deletion.
hook_disable	docs/docs/developer/hooks/install.php	Perform necessary actions before module is disabled.
hook_download_authorize	ubercart/docs/hooks.php	Give clearance to a user to download a file.
hook_elements	docs/docs/developer/hooks/core.php	Allows modules to declare their own Forms API element types and specify their default values.
hook_enable	docs/docs/developer/hooks/install.php	Perform necessary actions after module is enabled.
hook_exit	docs/docs/developer/hooks/core.php	Perform cleanup tasks.
hook_file_action	ubercart/docs/hooks.php	Perform actions on file products.
hook_file_download	docs/docs/developer/hooks/core.php	Control access to private file downloads and specify HTTP headers.
hook_file_transfer_alter	ubercart/docs/hooks.php	Make changes to a file before it is downloaded by the customer.
hook_filter	docs/docs/developer/hooks/core.php	Define content filters.
hook_filter_tips	docs/docs/developer/hooks/core.php	Provide tips for using filters.
hook_flush_caches	docs/docs/developer/hooks/core.php	Add a list of cache tables to be cleared.
hook_footer	docs/docs/developer/hooks/core.php	Insert closing HTML.
hook_form	docs/docs/developer/hooks/node.php	Display a node editing form.
hook_forms	docs/docs/developer/hooks/core.php	Map form_ids to builder functions.
hook_form_alter	docs/docs/developer/hooks/core.php	Perform alterations before a form is rendered.
hook_form_FORM_ID_alter	docs/docs/developer/hooks/core.php	Provide a form-specific alteration instead of the global hook_form_alter().
hook_help	docs/docs/developer/hooks/core.php	Provide online user help.
hook_hook_info	docs/docs/developer/hooks/core.php	Expose a list of triggers (events) that your module is allowing users to assign actions to.
hook_init	docs/docs/developer/hooks/core.php	Perform setup tasks. See also, hook_boot.
hook_insert	docs/docs/developer/hooks/node.php	Respond to node insertion.
hook_install	docs/docs/developer/hooks/install.php	Install the current version of the database schema, and any other setup tasks.
hook_line_item	ubercart/docs/hooks.php	Used to define line items that are attached to orders.
hook_line_item_alter	ubercart/docs/hooks.php	Alter a line item on an order when the order is loaded.
hook_line_item_data_alter	ubercart/docs/hooks.php	Alter the line item definitions declared in hook_line_item().
hook_link	docs/docs/developer/hooks/core.php	Define internal Drupal links.
hook_link_alter	docs/docs/developer/hooks/core.php	Perform alterations before links on a node are rendered. One popular use of this hook is to modify/remove links from other modules. If you want to add a link to the links section of a node, use hook_link instead.
hook_load	docs/docs/developer/hooks/node.php	Load node-type-specific information.
hook_locale	docs/docs/developer/hooks/core.php	Allows modules to define their own text groups that can be translated.
hook_mail	docs/docs/developer/hooks/core.php	Prepare a message based on parameters. @see drupal_mail for more.
hook_mail_alter	docs/docs/developer/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/docs/developer/hooks/core.php	Define menu items and page callbacks.
hook_menu_alter	docs/docs/developer/hooks/core.php	Alter the data being saved to the {menu_router} table after hook_menu is invoked.
hook_menu_link_alter	docs/docs/developer/hooks/core.php	Alter the data being saved to the {menu_links} table by menu_link_save().
hook_nodeapi	docs/docs/developer/hooks/core.php	Act on nodes defined by other modules.
hook_node_access_records	docs/docs/developer/hooks/core.php	Set permissions for a node to be written to the database.
hook_node_grants	docs/docs/developer/hooks/core.php	Inform the node access system what permissions the user has.
hook_node_info	docs/docs/developer/hooks/node.php	Define module-provided node types.
hook_node_operations	docs/docs/developer/hooks/core.php	Add mass node operations.
hook_node_type	docs/docs/developer/hooks/node.php	Act on node type changes.
hook_order	ubercart/docs/hooks.php	Perform actions on orders.
hook_order_actions	ubercart/docs/hooks.php	Add links to local tasks for orders on the admin's list of orders.
hook_order_pane	ubercart/docs/hooks.php	Register callbacks for an order pane.
hook_order_product_alter	ubercart/docs/hooks.php	Allows modules to alter ordered products when they're loaded with an order.
hook_order_state	ubercart/docs/hooks.php	Register static order states.
hook_payment_gateway	ubercart/docs/hooks.php	Register payment gateway callbacks. See also@link http://www.ubercart.org/docs/api/hook_payment_gateway @endlink
hook_payment_method	ubercart/docs/hooks.php	Register callbacks for payment methods.
hook_perm	docs/docs/developer/hooks/core.php	Define user permissions.
hook_ping	docs/docs/developer/hooks/core.php	Ping another server.
hook_prepare	docs/docs/developer/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_product_class	ubercart/docs/hooks.php	Perform actions on product classes.
hook_product_description	ubercart/docs/hooks.php	Return a structured array representing the given product's description.
hook_product_description_alter	ubercart/docs/hooks.php	Alters the given product description.
hook_product_types	ubercart/docs/hooks.php	List node types which should be considered products.
hook_profile_alter	docs/docs/developer/hooks/core.php	Perform alterations profile items before they are rendered. You may omit/add/re-sort/re-categorize, etc.
hook_requirements	docs/docs/developer/hooks/install.php	Check installation requirements and do status reporting.
hook_schema	docs/docs/developer/hooks/install.php	Define the current version of the database schema.
hook_schema_alter	docs/docs/developer/hooks/core.php	Perform alterations to existing database schemas.
hook_search	docs/docs/developer/hooks/core.php	Define a custom search routine.
hook_search_preprocess	docs/docs/developer/hooks/core.php	Preprocess text for the search index.
hook_shipment	ubercart/docs/hooks.php	Handle additional data for shipments.
hook_shipping_method	ubercart/docs/hooks.php	Define callbacks and service options for shipping methods.
hook_shipping_type	ubercart/docs/hooks.php	Define shipping types for shipping methods.
hook_store_status	ubercart/docs/hooks.php	Add status messages to the "Store administration" page.
hook_system_info_alter	docs/docs/developer/hooks/core.php	Alter the information parsed from module and theme .info files
hook_tapir_table_alter	ubercart/docs/hooks.php	Allow modules to alter the TAPIr table after the rows are populated.
hook_tapir_table_header_alter	ubercart/docs/hooks.php	Allow modules to alter TAPIr table headers.
hook_taxonomy	docs/docs/developer/hooks/core.php	Act on taxonomy changes.
hook_term_path	docs/docs/developer/hooks/core.php	Allows modules to provide an alternative path for the terms it manages.
hook_theme	docs/docs/developer/hooks/core.php	Register a module (or theme's) theme implementations.
hook_theme_registry_alter	docs/docs/developer/hooks/core.php	Alter the theme registry information returned from hook_theme().
hook_translated_menu_link_alter	docs/docs/developer/hooks/core.php	Alter a menu link after it's translated, but before it's rendered.
hook_translation_link_alter	docs/docs/developer/hooks/core.php	Perform alterations on translation links.
hook_ucga_display	ubercart/docs/hooks.php	Used to determine whether or not UC Google Analytics should add e-commerce tracking code to the bottom of the page.
hook_ucga_item_alter	ubercart/docs/hooks.php	Allows modules to alter items before they're added to the UC Google Analytics e-commerce tracking code.
hook_ucga_trans_alter	ubercart/docs/hooks.php	Allows modules to alter transaction info before it's added to the UC Google Analytics e-commerce tracking code.
hook_uc_checkout_complete	ubercart/docs/hooks.php	Take action when checkout is completed.
hook_uc_form_alter	ubercart/docs/hooks.php	Allow modules to modify forms before Drupal invokes hook_form_alter().
hook_uc_message	ubercart/docs/hooks.php	Convenience function to display large blocks of text in several places.
hook_uc_payment_entered	ubercart/docs/hooks.php	Take action when a payment is entered for an order.
hook_uc_price_handler	ubercart/docs/hooks.php	Use this hook to define price handlers for your module. You may define one price alterer and one price formatter. You may also define options that are merged into the options array in order of each price alterer's weight.
hook_uc_product_models	ubercart/docs/hooks.php	Notify core of any SKUs your module adds to a given node.
hook_uc_stock_adjusted	ubercart/docs/hooks.php	Allow modules to take action when a stock level is changed.
hook_uninstall	docs/docs/developer/hooks/install.php	Remove any tables or variables that the module sets.
hook_update	docs/docs/developer/hooks/node.php	Respond to node updating.
hook_update_cart_item	ubercart/docs/hooks.php	Handle requests to update a cart item.
hook_update_index	docs/docs/developer/hooks/core.php	Update Drupal's full-text index for this module.
hook_update_last_removed	docs/docs/developer/hooks/install.php	Return a number which is no longer available as hook_update_N().
hook_update_N	docs/docs/developer/hooks/install.php	Perform a single update.
hook_update_status_alter	docs/docs/developer/hooks/core.php	Alter the information about available updates for projects.
hook_user	docs/docs/developer/hooks/core.php	Act on user account actions.
hook_user_operations	docs/docs/developer/hooks/core.php	Add mass user operations.
hook_validate	docs/docs/developer/hooks/node.php	Verify a node editing form.
hook_view	docs/docs/developer/hooks/node.php	Display a node.
hook_watchdog	docs/docs/developer/hooks/core.php	Log an event message
hook_xmlrpc	docs/docs/developer/hooks/core.php	Register XML-RPC callbacks.
module_hook	drupal/includes/module.inc	Determine whether a module implements a hook.
module_implements	drupal/includes/module.inc	Determine which modules are implementing a hook.
module_invoke	drupal/includes/module.inc	Invoke a hook in a particular module.
module_invoke_all	drupal/includes/module.inc	Invoke a hook in all enabled modules that implement it.