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 calls 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 in 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-6/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-6/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... |
| drush_hook_COMMAND | contrib-6/drush/drush.api.php | Implementation of the actual drush command. |
| drush_hook_COMMAND_validate | contrib-6/drush/drush.api.php | Run before a specific command executes. |
| drush_hook_post_COMMAND | contrib-6/drush/drush.api.php | Run after a specific command executes. Logging an error stops command execution. |
| drush_hook_pre_COMMAND | contrib-6/drush/drush.api.php | Run before a specific command executes. Logging an error stops command execution. |
| hook_access | docs-6/hooks/node.php | Define access restrictions. |
| hook_actions_delete | docs-6/hooks/core.php | Execute code after an action is deleted. |
| hook_action_info | docs-6/hooks/core.php | Declare information about one or more Drupal actions. |
| hook_action_info_alter | docs-6/hooks/core.php | Alter the actions declared by another module. |
| hook_block | docs-6/hooks/core.php | Declare a block or set of blocks. |
| hook_boot | docs-6/hooks/core.php | Perform setup tasks. See also, hook_init. |
| hook_comment | docs-6/hooks/core.php | Respond to comment actions. |
| hook_cron | docs-6/hooks/core.php | Perform periodic actions. |
| hook_ctools_plugin_directory | contrib-6/ctools/ctools.api.php | This hook is used to inform the CTools plugin system about the location of a directory that should be searched for files containing plugins of a particular type. CTools invokes this same hook for all plugins, using the two passed parameters to... |
| hook_db_rewrite_sql | docs-6/hooks/core.php | Rewrite database queries, usually for access control. |
| hook_delete | docs-6/hooks/node.php | Respond to node deletion. |
| hook_disable | docs-6/hooks/install.php | Perform necessary actions before module is disabled. |
| hook_drush_exit | contrib-6/drush/drush.api.php | Take action after any command is run. |
| hook_drush_init | contrib-6/drush/drush.api.php | Take action before any command is run. Logging an error stops command execution. |
| hook_drush_pm_adjust_download_destination | contrib-6/drush/drush.api.php | Adjust the location that a project should be downloaded to. |
| hook_drush_pm_post_download | contrib-6/drush/drush.api.php | Take action after a project has been downloaded. |
| hook_ec_transaction_delete | contrib-6/ecommerce/ec_store/ec_store.api.php | Act when deleting transactions from the database. |
| hook_ec_transaction_insert | contrib-6/ecommerce/ec_store/ec_store.api.php | Act when inserting transactions into the database. |
| hook_ec_transaction_load | contrib-6/ecommerce/ec_store/ec_store.api.php | Act on transaction objects when loading them from the database. |
| hook_ec_transaction_post_save | contrib-6/ecommerce/ec_store/ec_store.api.php | Act after saving transaction into database. |
| hook_ec_transaction_pre_save | contrib-6/ecommerce/ec_store/ec_store.api.php | Act before saving transaction into database. |
| hook_ec_transaction_types | contrib-6/ecommerce/ec_store/ec_store.api.php | Allow modules to define custom transaction types. |
| hook_ec_transaction_update | contrib-6/ecommerce/ec_store/ec_store.api.php | Act when updating transactions into the database. |
| hook_elements | docs-6/hooks/core.php | Allows modules to declare their own Forms API element types and specify their default values. |
| hook_enable | docs-6/hooks/install.php | Perform necessary actions after module is enabled. |
| hook_exit | docs-6/hooks/core.php | Perform cleanup tasks. |
| hook_feature_attributes | contrib-6/ecommerce/ec_product/ec_product.features.api.php | Provide added product attributes via a feature |
| hook_feature_ec_checkout_validate_item | contrib-6/ecommerce/ec_product/ec_product.features.api.php | Check that a product can be purchased by the current user. |
| hook_feature_transaction_delete | contrib-6/ecommerce/ec_product/ec_product.features.api.php | Delete additional data into the system for later loading. |
| hook_feature_transaction_insert | contrib-6/ecommerce/ec_product/ec_product.features.api.php | Insert additional data into the system for later loading. |
| hook_feature_transaction_load | contrib-6/ecommerce/ec_product/ec_product.features.api.php | Load additional information into the transaction item. |
| hook_feature_transaction_update | contrib-6/ecommerce/ec_product/ec_product.features.api.php | Update additional data into the system for later loading. |
| hook_file_download | docs-6/hooks/core.php | Control access to private file downloads and specify HTTP headers. |
| hook_filter | docs-6/hooks/core.php | Define content filters. |
| hook_filter_tips | docs-6/hooks/core.php | Provide tips for using filters. |
| hook_flush_caches | docs-6/hooks/core.php | Add a list of cache tables to be cleared. |
| hook_footer | docs-6/hooks/core.php | Insert closing HTML. |
| hook_form | docs-6/hooks/node.php | Display a node editing form. |
| hook_forms | docs-6/hooks/core.php | Map form_ids to builder functions. |
| hook_form_alter | docs-6/hooks/core.php | Perform alterations before a form is rendered. |
| hook_form_FORM_ID_alter | docs-6/hooks/core.php | Provide a form-specific alteration instead of the global hook_form_alter(). |
| hook_help | docs-6/hooks/core.php | Provide online user help. |
| hook_hook_info | docs-6/hooks/core.php | Expose a list of triggers (events) that users can assign actions to. |
| hook_imagecache_actions | contrib-6/imagecache/imagecache.api.php | Inform ImageCache about actions that can be performed on an image. |
| hook_imagecache_default_presets | contrib-6/imagecache/imagecache.api.php | Provides default ImageCache presets that can be overridden by site administrators. |
| hook_init | docs-6/hooks/core.php | Perform setup tasks. See also, hook_boot. |
| hook_insert | docs-6/hooks/node.php | Respond to node insertion. |
| hook_install | docs-6/hooks/install.php | Install the current version of the database schema, and any other setup tasks. |
| hook_link | docs-6/hooks/core.php | Define internal Drupal links. |
| hook_link_alter | docs-6/hooks/core.php | Perform alterations before links on a node or comment are rendered. |
| hook_load | docs-6/hooks/node.php | Load node-type-specific information. |
| hook_locale | docs-6/hooks/core.php | Allows modules to define their own text groups that can be translated. |
| hook_mail | docs-6/hooks/core.php | Prepare a message based on parameters; called from drupal_mail(). |
| hook_mail_alter | docs-6/hooks/core.php | Alter any aspect of email sent by Drupal. You can use this hook to add a common site footer to all outgoing email, add extra header fields, and/or modify the email in any way. HTML-izing the outgoing email is one possibility. See also drupal_mail(). |
| hook_menu | docs-6/hooks/core.php | Define menu items and page callbacks. |
| hook_menu_alter | docs-6/hooks/core.php | Alter the data being saved to the {menu_router} table after hook_menu is invoked. |
| hook_menu_link_alter | docs-6/hooks/core.php | Alter the data being saved to the {menu_links} table by menu_link_save(). |
| hook_nodeapi | docs-6/hooks/core.php | Act on nodes defined by other modules. |
| hook_node_access_records | docs-6/hooks/core.php | Set permissions for a node to be written to the database. |
| hook_node_grants | docs-6/hooks/core.php | Inform the node access system what permissions the user has. |
| hook_node_info | docs-6/hooks/node.php | Define module-provided node types. |
| hook_node_operations | docs-6/hooks/core.php | Add mass node operations. |
| hook_node_type | docs-6/hooks/node.php | Act on node type changes. |
| hook_perm | docs-6/hooks/core.php | Define user permissions. |
| hook_ping | docs-6/hooks/core.php | Ping another server. |
| hook_pm_post_update | contrib-6/drush/drush.api.php | Take action after a project has been updated. |
| hook_prepare | docs-6/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-6/hooks/core.php | Alter profile items before they are rendered. |
| hook_receipt_info | contrib-6/ecommerce/ec_receipt/ec_receipt.api.php | Register a payment gateway. |
| hook_receipt_init | contrib-6/ecommerce/ec_receipt/ec_receipt.api.php | Initialize the selected receipting payment type. |
| hook_receipt_payment_form | contrib-6/ecommerce/ec_receipt/ec_receipt.api.php | Generation a form for the collection of the payment |
| hook_receipt_payment_url | contrib-6/ecommerce/ec_receipt/ec_receipt.api.php | Build the url to redirect to a hosted payment page. |
| hook_receipt_process_payment | contrib-6/ecommerce/ec_receipt/ec_receipt.api.php | Interface with the payment gateway to collect the payment. |
| hook_requirements | docs-6/hooks/install.php | Check installation requirements and do status reporting. |
| hook_schema | docs-6/hooks/install.php | Define the current version of the database schema. |
| hook_schema_alter | docs-6/hooks/core.php | Perform alterations to existing database schemas. |
| hook_search | docs-6/hooks/core.php | Define a custom search routine. |
| hook_search_preprocess | docs-6/hooks/core.php | Preprocess text for the search index. |
| hook_system_info_alter | docs-6/hooks/core.php | Alter the information parsed from module and theme .info files |
| hook_taxonomy | docs-6/hooks/core.php | Act on taxonomy changes. |
| hook_term_path | docs-6/hooks/core.php | Allows modules to provide an alternative path for the terms it manages. |
| hook_theme | docs-6/hooks/core.php | Register a module (or theme's) theme implementations. |
| hook_theme_registry_alter | docs-6/hooks/core.php | Alter the theme registry information returned from hook_theme(). |
| hook_translated_menu_link_alter | docs-6/hooks/core.php | Alter a menu link after it's translated, but before it's rendered. |
| hook_translation_link_alter | docs-6/hooks/core.php | Perform alterations on translation links. |
| hook_uninstall | docs-6/hooks/install.php | Remove any tables or variables that the module sets. |
| hook_update | docs-6/hooks/node.php | Respond to node updating. |
| hook_update_index | docs-6/hooks/core.php | Update Drupal's full-text index for this module. |
| hook_update_last_removed | docs-6/hooks/install.php | Return a number which is no longer available as hook_update_N(). |
| hook_update_N | docs-6/hooks/install.php | Perform a single update. |
| hook_update_projects_alter | docs-6/hooks/core.php | Alter the list of projects before fetching data and comparing versions. |
| hook_update_status_alter | docs-6/hooks/core.php | Alter the information about available updates for projects. |
| hook_user | docs-6/hooks/core.php | Act on user account actions. |
| hook_user_operations | docs-6/hooks/core.php | Add mass user operations. |
| hook_validate | docs-6/hooks/node.php | Verify a node editing form. |
| hook_view | docs-6/hooks/node.php | Display a node. |
| hook_watchdog | docs-6/hooks/core.php | Log an event message |
| hook_xmlrpc | docs-6/hooks/core.php | Register XML-RPC callbacks. |
| module_hook | drupal-6/includes/module.inc | Determine whether a module implements a hook. |
| module_implements | drupal-6/includes/module.inc | Determine which modules are implementing a hook. |
| module_invoke | drupal-6/includes/module.inc | Invoke a hook in a particular module. |
| module_invoke_all | drupal-6/includes/module.inc | Invoke a hook in all enabled modules that implement it. |
| subscriptions_blog_ui_count_user_subscriptions | contrib-6/subscriptions/subscriptions_blog_ui.module | Implementation of hook_count_user_subscriptions(). |
| subscriptions_blog_ui_subscriptions | contrib-6/subscriptions/subscriptions_blog_ui.module | Implementation of hook_subscriptions(). |
| subscriptions_cck_subscriptions_get_mailvars | contrib-6/subscriptions/subscriptions_cck.module | Implementation of hook_subscriptions_get_mailvars(). |
| subscriptions_cck_subscriptions_tokens_list | contrib-6/subscriptions/subscriptions_cck.module | Implementation of hook_subscriptions_tokens_list(). |
| subscriptions_content_cron | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_cron(). |
| subscriptions_content_disable | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_disable(). |
| subscriptions_content_form_alter | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_form_alter(). |
| subscriptions_content_form_comment_form_alter | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_form_alter(). |
| subscriptions_content_form_mail_edit_trans_alter | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_form_alter(). |
| subscriptions_content_form_node_admin_nodes_alter | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_form_alter(). |
| subscriptions_content_form_node_type_form_alter | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_form_alter(). |
| subscriptions_content_form_subscriptions_settings_form_alter | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_form_alter(). |
| subscriptions_content_mailkeys | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_mailkeys(). |
| subscriptions_content_mail_edit_text | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_mail_edit_text(). |
| subscriptions_content_mail_edit_tokens_list | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_mail_edit_tokens_list(). |
| subscriptions_content_node_type | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_node_type(). |
| subscriptions_content_subscriptions | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_subscriptions(). |
| subscriptions_form_user_profile_form_alter | contrib-6/subscriptions/subscriptions.module | Implementation of hook_form_alter() for the user/uid/edit form. |
| subscriptions_init | contrib-6/subscriptions/subscriptions.module | Implementation of hook_init(). |
| subscriptions_mail_form_mail_edit_trans_alter | contrib-6/subscriptions/subscriptions_mail.module | Implementation of hook_form_alter(). |
| subscriptions_mail_mailkeys | contrib-6/subscriptions/subscriptions_mail.module | Implementation of hook_mailkeys(). |
| subscriptions_mail_mail_edit_text | contrib-6/subscriptions/subscriptions_mail.module | Implementation of hook_mail_edit_text(). |
| subscriptions_mail_mail_edit_tokens_list | contrib-6/subscriptions/subscriptions_mail.module | Implementation of hook_mail_edit_tokens_list(). |
| subscriptions_mail_subscriptions_mail_text | contrib-6/subscriptions/subscriptions_mail.module | Implementation of hook_subscriptions_mail_text(). |
| subscriptions_mail_subscriptions_tokens_list | contrib-6/subscriptions/subscriptions_mail.module | Implementation of hook_subscriptions_tokens_list(). |
| subscriptions_menu | contrib-6/subscriptions/subscriptions.module | Implementation of hook_menu(). |
| subscriptions_perm | contrib-6/subscriptions/subscriptions.module | Implementation of hook_perms(). |
| subscriptions_taxonomy_disable | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_disable(). |
| subscriptions_taxonomy_form_subscriptions_settings_form_alter | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_form_alter(). |
| subscriptions_taxonomy_mailkeys | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_mailkeys(). |
| subscriptions_taxonomy_mail_edit_text | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_mail_edit_text(). |
| subscriptions_taxonomy_mail_edit_tokens_list | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_mail_edit_tokens_list(). |
| subscriptions_taxonomy_subscriptions | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_subscriptions(). |
| subscriptions_taxonomy_taxonomy | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_taxonomy(). |
| subscriptions_types | contrib-6/subscriptions/subscriptions.module | Hook subscription_types(). Get info about subscription types. |
| subscriptions_ui_block | contrib-6/subscriptions/subscriptions_ui.module | Implementation of hook_block(). |
| subscriptions_ui_content_extra_fields | contrib-6/subscriptions/subscriptions_ui.module | Implementation of hook hook_content_extra_fields(). |
| subscriptions_ui_form_subscriptions_settings_form_alter | contrib-6/subscriptions/subscriptions_ui.module | Implementation of hook form_alter(). |
| subscriptions_ui_link | contrib-6/subscriptions/subscriptions_ui.module | Implementation of hook_link(). |
| subscriptions_ui_nodeapi | contrib-6/subscriptions/subscriptions_ui.module | Implementation of hook_nodeapi(). |
| subscriptions_ui_node_form | contrib-6/subscriptions/subscriptions_ui.module | Returns the form definition for the node subform. |
| subscriptions_user | contrib-6/subscriptions/subscriptions.module | Implementation of hook_user(). |
| _subscriptions_blog_ui_types | contrib-6/subscriptions/subscriptions_blog_ui.module | Implementation of hook_types(), subhook of hook_subscriptions(). |
| _subscriptions_content_access | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_access(), subhook of hook_subscriptions(). |
| _subscriptions_content_node_options | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_node_options(), subhook of hook_subscriptions(). |
| _subscriptions_content_types | contrib-6/subscriptions/subscriptions_content.module | Implementation of hook_types(), subhook of hook_subscriptions(). |
| _subscriptions_mail_form_mail_edit_trans_alter | contrib-6/subscriptions/subscriptions_mail.admin.inc | Implementation of hook_form_alter(). |
| _subscriptions_taxonomy_node_options | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_node_options(), subhook of hook_subscriptions(). |
| _subscriptions_taxonomy_types | contrib-6/subscriptions/subscriptions_taxonomy.module | Implementation of hook_types(), subhook of hook_subscriptions(). |
Post new comment
