Documentation & API reference
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().
The example functions included are not part of the Drupal core, they are just models that you can modify. Only the hooks implemented within modules are executed when running Drupal.
See also
File
- drupal/
includes/ module.inc, line 609 - API for loading and interacting with Drupal modules.
Functions
| Name |
Location |
Description |
|---|---|---|
| module_hook |
drupal/ |
Determines whether a module implements a hook. |
| module_implements |
drupal/ |
Determines which modules are implementing a hook. |
| module_hook_info |
drupal/ |
Retrieves a list of hooks that are declared through hook_hook_info(). |
| module_implements_write_cache |
drupal/ |
Writes the hook implementation cache. |
| module_invoke |
drupal/ |
Invokes a hook in a particular module. |
| module_invoke_all |
drupal/ |
Invokes a hook in all enabled modules that implement it. |
| hook_aggregator_fetch |
drupal/ |
Create an alternative fetcher for aggregator.module. |
| hook_aggregator_fetch_info |
drupal/ |
Specify the title and short description of your fetcher. |
| hook_aggregator_parse |
drupal/ |
Create an alternative parser for aggregator module. |
| hook_aggregator_parse_info |
drupal/ |
Specify the title and short description of your parser. |
| hook_aggregator_process |
drupal/ |
Create a processor for aggregator.module. |
| hook_aggregator_process_info |
drupal/ |
Specify the title and short description of your processor. |
| hook_aggregator_remove |
drupal/ |
Remove stored feed data. |
| hook_block_info |
drupal/ |
Define all blocks provided by the module. |
| hook_block_info_alter |
drupal/ |
Change block definition before saving to the database. |
| hook_block_configure |
drupal/ |
Define a configuration form for a block. |
| hook_block_save |
drupal/ |
Save the configuration options from hook_block_configure(). |
| hook_block_view |
drupal/ |
Return a rendered or renderable view of a block. |
| hook_block_view_alter |
drupal/ |
Perform alterations to the content of a block. |
| hook_block_view_MODULE_DELTA_alter |
drupal/ |
Perform alterations to a specific block. |
| hook_block_list_alter |
drupal/ |
Act on blocks prior to rendering. |
| hook_block_cid_parts_alter |
drupal/ |
Act on block cache ID (cid) parts before the cid is generated. |
| hook_comment_presave |
drupal/ |
The comment passed validation and is about to be saved. |
| hook_comment_insert |
drupal/ |
The comment is being inserted. |
| hook_comment_update |
drupal/ |
The comment is being updated. |
| hook_comment_load |
drupal/ |
Comments are being loaded from the database. |
| hook_comment_view |
drupal/ |
The comment is being viewed. This hook can be used to add additional data to the comment before theming. |
| hook_comment_view_alter |
drupal/ |
The comment was built; the module may modify the structured content. |
| hook_comment_publish |
drupal/ |
The comment is being published by the moderator. |
| hook_comment_unpublish |
drupal/ |
The comment is being unpublished by the moderator. |
| hook_comment_delete |
drupal/ |
The comment is being deleted by the moderator. |
| hook_contextual_links_view_alter |
drupal/ |
Alter a contextual links element before it is rendered. |
| hook_dashboard_regions |
drupal/ |
Add regions to the dashboard. |
| hook_dashboard_regions_alter |
drupal/ |
Alter dashboard regions provided by modules. |
| hook_field_extra_fields |
drupal/ |
Exposes "pseudo-field" components on fieldable entities. |
| hook_field_extra_fields_alter |
drupal/ |
Alter "pseudo-field" components on fieldable entities. |
| hook_field_info |
drupal/ |
Define Field API field types. |
| hook_field_info_alter |
drupal/ |
Perform alterations on Field API field types. |
| hook_field_schema |
drupal/ |
Define the Field API schema for a field structure. |
| hook_field_load |
drupal/ |
Define custom load behavior for this module's field types. |
| hook_field_prepare_view |
drupal/ |
Prepare field values prior to display. |
| hook_field_validate |
drupal/ |
Validate this module's field data. |
| hook_field_presave |
drupal/ |
Define custom presave behavior for this module's field types. |
| hook_field_insert |
drupal/ |
Define custom insert behavior for this module's field data. |
| hook_field_update |
drupal/ |
Define custom update behavior for this module's field data. |
| hook_field_storage_update_field |
drupal/ |
Update the storage information for a field. |
| hook_field_delete |
drupal/ |
Define custom delete behavior for this module's field data. |
| hook_field_delete_revision |
drupal/ |
Define custom revision delete behavior for this module's field types. |
| hook_field_prepare_translation |
drupal/ |
Define custom prepare_translation behavior for this module's field types. |
| hook_field_is_empty |
drupal/ |
Define what constitutes an empty item for a field type. |
| hook_field_widget_info |
drupal/ |
Expose Field API widget types. |
| hook_field_widget_info_alter |
drupal/ |
Perform alterations on Field API widget types. |
| hook_field_widget_form |
drupal/ |
Return the form for a single field widget. |
| hook_field_widget_form_alter |
drupal/ |
Alter forms for field widgets provided by other modules. |
| hook_field_widget_WIDGET_TYPE_form_alter |
drupal/ |
Alter widget forms for a specific widget provided by another module. |
| hook_field_widget_properties_alter |
drupal/ |
Alters the widget properties of a field instance before it gets displayed. |
| hook_field_widget_error |
drupal/ |
Flag a field-level validation error. |
| hook_field_formatter_info |
drupal/ |
Expose Field API formatter types. |
| hook_field_formatter_info_alter |
drupal/ |
Perform alterations on Field API formatter types. |
| hook_field_formatter_prepare_view |
drupal/ |
Allow formatters to load information for field values being displayed. |
| hook_field_formatter_view |
drupal/ |
Build a renderable array for a field value. |
| hook_field_attach_form |
drupal/ |
Act on field_attach_form(). |
| hook_field_attach_load |
drupal/ |
Act on field_attach_load(). |
| hook_field_attach_validate |
drupal/ |
Act on field_attach_validate(). |
| hook_field_attach_submit |
drupal/ |
Act on field_attach_submit(). |
| hook_field_attach_presave |
drupal/ |
Act on field_attach_presave(). |
| hook_field_attach_insert |
drupal/ |
Act on field_attach_insert(). |
| hook_field_attach_update |
drupal/ |
Act on field_attach_update(). |
| hook_field_attach_preprocess_alter |
drupal/ |
Alter field_attach_preprocess() variables. |
| hook_field_attach_delete |
drupal/ |
Act on field_attach_delete(). |
| hook_field_attach_delete_revision |
drupal/ |
Act on field_attach_delete_revision(). |
| hook_field_attach_purge |
drupal/ |
Act on field_purge_data(). |
| hook_field_attach_view_alter |
drupal/ |
Perform alterations on field_attach_view() or field_view_field(). |
| hook_field_attach_prepare_translation_alter |
drupal/ |
Perform alterations on field_attach_prepare_translation(). |
| hook_field_language_alter |
drupal/ |
Perform alterations on field_language() values. |
| hook_field_available_languages_alter |
drupal/ |
Alter field_available_languages() values. |
| hook_field_attach_create_bundle |
drupal/ |
Act on field_attach_create_bundle(). |
| hook_field_attach_rename_bundle |
drupal/ |
Act on field_attach_rename_bundle(). |
| hook_field_attach_delete_bundle |
drupal/ |
Act on field_attach_delete_bundle. |
| hook_field_storage_info |
drupal/ |
Expose Field API storage backends. |
| hook_field_storage_info_alter |
drupal/ |
Perform alterations on Field API storage types. |
| hook_field_storage_details |
drupal/ |
Reveal the internal details about the storage for a field. |
| hook_field_storage_details_alter |
drupal/ |
Perform alterations on Field API storage details. |
| hook_field_storage_load |
drupal/ |
Load field data for a set of entities. |
| hook_field_storage_write |
drupal/ |
Write field data for an entity. |
| hook_field_storage_delete |
drupal/ |
Delete all field data for an entity. |
| hook_field_storage_delete_revision |
drupal/ |
Delete a single revision of field data for an entity. |
| hook_field_storage_query |
drupal/ |
Execute an EntityFieldQuery. |
| hook_field_storage_create_field |
drupal/ |
Act on creation of a new field. |
| hook_field_storage_delete_field |
drupal/ |
Act on deletion of a field. |
| hook_field_storage_delete_instance |
drupal/ |
Act on deletion of a field instance. |
| hook_field_storage_pre_load |
drupal/ |
Act before the storage backends load field data. |
| hook_field_storage_pre_insert |
drupal/ |
Act before the storage backends insert field data. |
| hook_field_storage_pre_update |
drupal/ |
Act before the storage backends update field data. |
| hook_field_info_max_weight |
drupal/ |
Returns the maximum weight for the entity components handled by the module. |
| hook_field_display_alter |
drupal/ |
Alters the display settings of a field before it gets displayed. |
| hook_field_display_ENTITY_TYPE_alter |
drupal/ |
Alters the display settings of a field on a given entity type before it gets displayed. |
| hook_field_extra_fields_display_alter |
drupal/ |
Alters the display settings of pseudo-fields before an entity is displayed. |
| hook_field_widget_properties_ENTITY_TYPE_alter |
drupal/ |
Alters the widget properties of a field instance on a given entity type before it gets displayed. |
| hook_field_create_field |
drupal/ |
Act on a field being created. |
| hook_field_create_instance |
drupal/ |
Act on a field instance being created. |
| hook_field_update_forbid |
drupal/ |
Forbid a field update from occurring. |
| hook_field_update_field |
drupal/ |
Act on a field being updated. |
| hook_field_delete_field |
drupal/ |
Act on a field being deleted. |
| hook_field_update_instance |
drupal/ |
Act on a field instance being updated. |
| hook_field_delete_instance |
drupal/ |
Act on a field instance being deleted. |
| hook_field_read_field |
drupal/ |
Act on field records being read from the database. |
| hook_field_read_instance |
drupal/ |
Act on a field record being read from the database. |
| hook_field_purge_field |
drupal/ |
Acts when a field record is being purged. |
| hook_field_purge_instance |
drupal/ |
Acts when a field instance is being purged. |
| hook_field_storage_purge_field |
drupal/ |
Remove field storage information when a field record is purged. |
| hook_field_storage_purge_field_instance |
drupal/ |
Remove field storage information when a field instance is purged. |
| hook_field_storage_purge |
drupal/ |
Remove field storage information when field data is purged. |
| hook_field_access |
drupal/ |
Determine whether the user has access to a given field. |
| hook_filter_info |
drupal/ |
Define content filters. |
| hook_filter_info_alter |
drupal/ |
Perform alterations on filter definitions. |
| hook_filter_format_insert |
drupal/ |
Perform actions when a new text format has been created. |
| hook_filter_format_update |
drupal/ |
Perform actions when a text format has been updated. |
| hook_filter_format_disable |
drupal/ |
Perform actions when a text format has been disabled. |
| hook_image_effect_info |
drupal/ |
Define information about image effects provided by a module. |
| hook_image_effect_info_alter |
drupal/ |
Alter the information provided in hook_image_effect_info(). |
| hook_image_style_save |
drupal/ |
Respond to image style updating. |
| hook_image_style_delete |
drupal/ |
Respond to image style deletion. |
| hook_image_style_flush |
drupal/ |
Respond to image style flushing. |
| hook_image_styles_alter |
drupal/ |
Modify any image styles provided by other modules or the user. |
| hook_image_default_styles |
drupal/ |
Provide module-based image styles for reuse throughout Drupal. |
| hook_locale |
drupal/ |
Allows modules to define their own text groups that can be translated. |
| hook_multilingual_settings_changed |
drupal/ |
Allow modules to react to language settings changes. |
| hook_menu_insert |
drupal/ |
Respond to a custom menu creation. |
| hook_menu_update |
drupal/ |
Respond to a custom menu update. |
| hook_menu_delete |
drupal/ |
Respond to a custom menu deletion. |
| hook_node_grants |
drupal/ |
Inform the node access system what permissions the user has. |
| hook_node_access_records |
drupal/ |
Set permissions for a node to be written to the database. |
| hook_node_access_records_alter |
drupal/ |
Alter permissions for a node before it is written to the database. |
| hook_node_grants_alter |
drupal/ |
Alter user access rules when trying to view, edit or delete a node. |
| hook_node_operations |
drupal/ |
Add mass node operations. |
| hook_node_delete |
drupal/ |
Respond to node deletion. |
| hook_node_revision_delete |
drupal/ |
Respond to deletion of a node revision. |
| hook_node_insert |
drupal/ |
Respond to creation of a new node. |
| hook_node_load |
drupal/ |
Act on arbitrary nodes being loaded from the database. |
| hook_node_access |
drupal/ |
Control access to a node. |
| hook_node_prepare |
drupal/ |
Act on a node object about to be shown on the add/edit form. |
| hook_node_search_result |
drupal/ |
Act on a node being displayed as a search result. |
| hook_node_presave |
drupal/ |
Act on a node being inserted or updated. |
| hook_node_update |
drupal/ |
Respond to updates to a node. |
| hook_node_update_index |
drupal/ |
Act on a node being indexed for searching. |
| hook_node_validate |
drupal/ |
Perform node validation before a node is created or updated. |
| hook_node_submit |
drupal/ |
Act on a node after validated form values have been copied to it. |
| hook_node_view |
drupal/ |
Act on a node that is being assembled before rendering. |
| hook_node_view_alter |
drupal/ |
Alter the results of node_view(). |
| hook_node_info |
drupal/ |
Define module-provided node types. |
| hook_ranking |
drupal/ |
Provide additional methods of scoring for core search results for nodes. |
| hook_node_type_insert |
drupal/ |
Respond to node type creation. |
| hook_node_type_update |
drupal/ |
Respond to node type updates. |
| hook_node_type_delete |
drupal/ |
Respond to node type deletion. |
| hook_delete |
drupal/ |
Respond to node deletion. |
| hook_prepare |
drupal/ |
Act on a node object about to be shown on the add/edit form. |
| hook_form |
drupal/ |
Display a node editing form. |
| hook_insert |
drupal/ |
Respond to creation of a new node. |
| hook_load |
drupal/ |
Act on nodes being loaded from the database. |
| hook_update |
drupal/ |
Respond to updates to a node. |
| hook_validate |
drupal/ |
Perform node validation before a node is created or updated. |
| hook_view |
drupal/ |
Display a node. |
| hook_openid |
drupal/ |
Allow modules to modify the OpenID request parameters. |
| hook_openid_response |
drupal/ |
Allow modules to act upon a successful OpenID login. |
| hook_openid_discovery_method_info |
drupal/ |
Allow modules to declare OpenID discovery methods. |
| hook_openid_discovery_method_info_alter |
drupal/ |
Allow modules to alter discovery methods. |
| hook_openid_normalization_method_info |
drupal/ |
Allow modules to declare OpenID normalization methods. |
| hook_openid_normalization_method_info_alter |
drupal/ |
Allow modules to alter normalization methods. |
| hook_overlay_parent_initialize |
drupal/ |
Allow modules to act when an overlay parent window is initialized. |
| hook_overlay_child_initialize |
drupal/ |
Allow modules to act when an overlay child window is initialized. |
| hook_path_insert |
drupal/ |
Respond to a path being inserted. |
| hook_path_update |
drupal/ |
Respond to a path being updated. |
| hook_path_delete |
drupal/ |
Respond to a path being deleted. |
| hook_rdf_mapping |
drupal/ |
Allow modules to define RDF mappings for field bundles. |
| hook_rdf_namespaces |
drupal/ |
Allow modules to define namespaces for RDF mappings. |
| hook_search_info |
drupal/ |
Define a custom search type. |
| hook_search_access |
drupal/ |
Define access to a custom search routine. |
| hook_search_reset |
drupal/ |
Take action when the search index is going to be rebuilt. |
| hook_search_status |
drupal/ |
Report the status of indexing. |
| hook_search_admin |
drupal/ |
Add elements to the search settings form. |
| hook_search_execute |
drupal/ |
Execute a search for a set of key words. |
| hook_search_page |
drupal/ |
Override the rendering of search results. |
| hook_search_preprocess |
drupal/ |
Preprocess text for search. |
| hook_update_index |
drupal/ |
Update the search index for this module. |
| hook_shortcut_default_set |
drupal/ |
Return the name of a default shortcut set for the provided user account. |
| hook_simpletest_alter |
drupal/ |
Alter the list of tests. |
| hook_test_group_started |
drupal/ |
A test group has started. |
| hook_test_group_finished |
drupal/ |
A test group has finished. |
| hook_test_finished |
drupal/ |
An individual test has finished. |
| hook_language_init |
drupal/ |
Allows modules to act after language initialization has been performed. |
| hook_language_switch_links_alter |
drupal/ |
Perform alterations on language switcher links. |
| hook_language_types_info |
drupal/ |
Define language types. |
| hook_language_types_info_alter |
drupal/ |
Perform alterations on language types. |
| hook_language_negotiation_info |
drupal/ |
Define language negotiation providers. |
| hook_language_negotiation_info_alter |
drupal/ |
Perform alterations on language negoiation providers. |
| hook_language_fallback_candidates_alter |
drupal/ |
Perform alterations on the language fallback candidates. |
| hook_hook_info |
drupal/ |
Defines one or more hooks that are exposed by a module. |
| hook_hook_info_alter |
drupal/ |
Alter information from hook_hook_info(). |
| hook_entity_info |
drupal/ |
Inform the base system and the Field API about one or more entity types. |
| hook_entity_info_alter |
drupal/ |
Alter the entity info. |
| hook_entity_load |
drupal/ |
Act on entities when loaded. |
| hook_entity_presave |
drupal/ |
Act on an entity before it is about to be created or updated. |
| hook_entity_insert |
drupal/ |
Act on entities when inserted. |
| hook_entity_update |
drupal/ |
Act on entities when updated. |
| hook_entity_delete |
drupal/ |
Act on entities when deleted. |
| hook_entity_query_alter |
drupal/ |
Alter or execute an EntityFieldQuery. |
| hook_entity_view |
drupal/ |
Act on entities being assembled before rendering. |
| hook_entity_view_alter |
drupal/ |
Alter the results of ENTITY_view(). |
| hook_entity_view_mode_alter |
drupal/ |
Change the view mode of an entity that is being displayed. |
| hook_admin_paths |
drupal/ |
Define administrative paths. |
| hook_admin_paths_alter |
drupal/ |
Redefine administrative paths defined by other modules. |
| hook_entity_prepare_view |
drupal/ |
Act on entities as they are being prepared for view. |
| hook_cron |
drupal/ |
Perform periodic actions. |
| hook_cron_queue_info |
drupal/ |
Declare queues holding items that need to be run periodically. |
| hook_cron_queue_info_alter |
drupal/ |
Alter cron queue information before cron runs. |
| hook_element_info |
drupal/ |
Allows modules to declare their own Form API element types and specify their default values. |
| hook_element_info_alter |
drupal/ |
Alter the element type information returned from modules. |
| hook_exit |
drupal/ |
Perform cleanup tasks. |
| hook_js_alter |
drupal/ |
Perform necessary alterations to the JavaScript before it is presented on the page. |
| hook_library |
drupal/ |
Registers JavaScript/CSS libraries associated with a module. |
| hook_library_alter |
drupal/ |
Alters the JavaScript/CSS library registry. |
| hook_css_alter |
drupal/ |
Alter CSS files before they are output on the page. |
| hook_ajax_render_alter |
drupal/ |
Alter the commands that are sent to the user through the Ajax framework. |
| hook_page_build |
drupal/ |
Add elements to a page before it is rendered. |
| hook_menu_get_item_alter |
drupal/ |
Alter a menu router item right after it has been retrieved from the database or cache. |
| hook_menu |
drupal/ |
Define menu items and page callbacks. |
| hook_menu_alter |
drupal/ |
Alter the data being saved to the {menu_router} table after hook_menu is invoked. |
| hook_menu_link_alter |
drupal/ |
Alter the data being saved to the {menu_links} table by menu_link_save(). |
| hook_translated_menu_link_alter |
drupal/ |
Alter a menu link after it has been translated and before it is rendered. |
| hook_menu_link_insert |
drupal/ |
Inform modules that a menu link has been created. |
| hook_menu_link_update |
drupal/ |
Inform modules that a menu link has been updated. |
| hook_menu_link_delete |
drupal/ |
Inform modules that a menu link has been deleted. |
| hook_menu_local_tasks_alter |
drupal/ |
Alter tabs and actions displayed on the page before they are rendered. |
| hook_menu_breadcrumb_alter |
drupal/ |
Alter links in the active trail before it is rendered as the breadcrumb. |
| hook_menu_contextual_links_alter |
drupal/ |
Alter contextual links before they are rendered. |
| hook_page_alter |
drupal/ |
Perform alterations before a page is rendered. |
| hook_form_alter |
drupal/ |
Perform alterations before a form is rendered. |
| hook_form_FORM_ID_alter |
drupal/ |
Provide a form-specific alteration instead of the global hook_form_alter(). |
| hook_form_BASE_FORM_ID_alter |
drupal/ |
Provide a form-specific alteration for shared ('base') forms. |
| hook_forms |
drupal/ |
Map form_ids to form builder functions. |
| hook_boot |
drupal/ |
Perform setup tasks for all page requests. |
| hook_init |
drupal/ |
Perform setup tasks for non-cached page requests. |
| hook_image_toolkits |
drupal/ |
Define image toolkits provided by this module. |
| hook_mail_alter |
drupal/ |
Alter an email message created with the drupal_mail() function. |
| hook_module_implements_alter |
drupal/ |
Alter the registry of modules implementing a hook. |
| hook_system_theme_info |
drupal/ |
Return additional themes provided by modules. |
| hook_system_theme_engine_info |
drupal/ |
Return additional theme engines provided by modules. |
| hook_system_info_alter |
drupal/ |
Alter the information parsed from module and theme .info files |
| hook_permission |
drupal/ |
Define user permissions. |
| hook_help |
drupal/ |
Provide online user help. |
| hook_theme |
drupal/ |
Register a module (or theme's) theme implementations. |
| hook_theme_registry_alter |
drupal/ |
Alter the theme registry information returned from hook_theme(). |
| hook_custom_theme |
drupal/ |
Return the machine-readable name of the theme to use for the current page. |
| hook_xmlrpc |
drupal/ |
Register XML-RPC callbacks. |
| hook_xmlrpc_alter |
drupal/ |
Alters the definition of XML-RPC methods before they are called. |
| hook_watchdog |
drupal/ |
Log an event message. |
| hook_mail |
drupal/ |
Prepare a message based on parameters; called from drupal_mail(). |
| hook_flush_caches |
drupal/ |
Add a list of cache tables to be cleared. |
| hook_modules_installed |
drupal/ |
Perform necessary actions after modules are installed. |
| hook_modules_enabled |
drupal/ |
Perform necessary actions after modules are enabled. |
| hook_modules_disabled |
drupal/ |
Perform necessary actions after modules are disabled. |
| hook_modules_uninstalled |
drupal/ |
Perform necessary actions after modules are uninstalled. |
| hook_stream_wrappers |
drupal/ |
Registers PHP stream wrapper implementations associated with a module. |
| hook_stream_wrappers_alter |
drupal/ |
Alters the list of PHP stream wrapper implementations. |
| hook_file_load |
drupal/ |
Load additional information into file objects. |
| hook_file_validate |
drupal/ |
Check that files meet a given criteria. |
| hook_file_presave |
drupal/ |
Act on a file being inserted or updated. |
| hook_file_insert |
drupal/ |
Respond to a file being added. |
| hook_file_update |
drupal/ |
Respond to a file being updated. |
| hook_file_copy |
drupal/ |
Respond to a file that has been copied. |
| hook_file_move |
drupal/ |
Respond to a file that has been moved. |
| hook_file_delete |
drupal/ |
Respond to a file being deleted. |
| hook_file_download |
drupal/ |
Control access to private file downloads and specify HTTP headers. |
| hook_file_url_alter |
drupal/ |
Alter the URL to a file. |
| hook_requirements |
drupal/ |
Check installation requirements and do status reporting. |
| hook_schema |
drupal/ |
Define the current version of the database schema. |
| hook_schema_alter |
drupal/ |
Perform alterations to existing database schemas. |
| hook_query_alter |
drupal/ |
Perform alterations to a structured query. |
| hook_query_TAG_alter |
drupal/ |
Perform alterations to a structured query for a given tag. |
| hook_install |
drupal/ |
Perform setup tasks when the module is installed. |
| hook_update_N |
drupal/ |
Perform a single update. |
| hook_update_dependencies |
drupal/ |
Return an array of information about module update dependencies. |
| hook_update_last_removed |
drupal/ |
Return a number which is no longer available as hook_update_N(). |
| hook_uninstall |
drupal/ |
Remove any information that the module sets. |
| hook_enable |
drupal/ |
Perform necessary actions after module is enabled. |
| hook_disable |
drupal/ |
Perform necessary actions before module is disabled. |
| hook_registry_files_alter |
drupal/ |
Perform necessary alterations to the list of files parsed by the registry. |
| hook_install_tasks |
drupal/ |
Return an array of tasks to be performed by an installation profile. |
| hook_drupal_goto_alter |
drupal/ |
Change the page the user is sent to by drupal_goto(). |
| hook_html_head_alter |
drupal/ |
Alter XHTML HEAD tags before they are rendered by drupal_get_html_head(). |
| hook_install_tasks_alter |
drupal/ |
Alter the full list of installation tasks. |
| hook_file_mimetype_mapping_alter |
drupal/ |
Alter MIME type mappings used to determine MIME type from a file extension. |
| hook_action_info |
drupal/ |
Declares information about actions. |
| hook_actions_delete |
drupal/ |
Executes code after an action is deleted. |
| hook_action_info_alter |
drupal/ |
Alters the actions declared by another module. |
| hook_archiver_info |
drupal/ |
Declare archivers to the system. |
| hook_archiver_info_alter |
drupal/ |
Alter archiver information declared by other modules. |
| hook_date_format_types |
drupal/ |
Define additional date types. |
| hook_date_format_types_alter |
drupal/ |
Modify existing date types. |
| hook_date_formats |
drupal/ |
Define additional date formats. |
| hook_date_formats_alter |
drupal/ |
Alter date formats declared by another module. |
| hook_page_delivery_callback_alter |
drupal/ |
Alters the delivery callback used to send the result of the page callback to the browser. |
| hook_system_themes_page_alter |
drupal/ |
Alters theme operation links. |
| hook_url_inbound_alter |
drupal/ |
Alters inbound URL requests. |
| hook_url_outbound_alter |
drupal/ |
Alters outbound URLs. |
| hook_username_alter |
drupal/ |
Alter the username that is displayed for a user. |
| hook_tokens |
drupal/ |
Provide replacement values for placeholder tokens. |
| hook_tokens_alter |
drupal/ |
Alter replacement values for placeholder tokens. |
| hook_token_info |
drupal/ |
Provide information about available placeholder tokens and token types. |
| hook_token_info_alter |
drupal/ |
Alter the metadata about available placeholder tokens and token types. |
| hook_batch_alter |
drupal/ |
Alter batch information before a batch is processed. |
| hook_updater_info |
drupal/ |
Provide information on Updaters (classes that can update Drupal). |
| hook_updater_info_alter |
drupal/ |
Alter the Updater information array. |
| hook_countries_alter |
drupal/ |
Alter the default country list. |
| hook_menu_site_status_alter |
drupal/ |
Control site status before menu dispatching. |
| hook_filetransfer_info |
drupal/ |
Register information about FileTransfer classes provided by a module. |
| hook_filetransfer_info_alter |
drupal/ |
Alter the FileTransfer class registry. |
| hook_taxonomy_vocabulary_load |
drupal/ |
Act on taxonomy vocabularies when loaded. |
| hook_taxonomy_vocabulary_presave |
drupal/ |
Act on taxonomy vocabularies before they are saved. |
| hook_taxonomy_vocabulary_insert |
drupal/ |
Act on taxonomy vocabularies when inserted. |
| hook_taxonomy_vocabulary_update |
drupal/ |
Act on taxonomy vocabularies when updated. |
| hook_taxonomy_vocabulary_delete |
drupal/ |
Respond to the deletion of taxonomy vocabularies. |
| hook_taxonomy_term_load |
drupal/ |
Act on taxonomy terms when loaded. |
| hook_taxonomy_term_presave |
drupal/ |
Act on taxonomy terms before they are saved. |
| hook_taxonomy_term_insert |
drupal/ |
Act on taxonomy terms when inserted. |
| hook_taxonomy_term_update |
drupal/ |
Act on taxonomy terms when updated. |
| hook_taxonomy_term_delete |
drupal/ |
Respond to the deletion of taxonomy terms. |
| hook_taxonomy_term_view |
drupal/ |
Act on a taxonomy term that is being assembled before rendering. |
| hook_taxonomy_term_view_alter |
drupal/ |
Alter the results of taxonomy_term_view(). |
| hook_trigger_info |
drupal/ |
Declare triggers (events) for users to assign actions to. |
| hook_trigger_info_alter |
drupal/ |
Alter triggers declared by hook_trigger_info(). |
| hook_update_projects_alter |
drupal/ |
Alter the list of projects before fetching data and comparing versions. |
| hook_update_status_alter |
drupal/ |
Alter the information about available updates for projects. |
| hook_verify_update_archive |
drupal/ |
Verify an archive after it has been downloaded and extracted. |
| hook_user_load |
drupal/ |
Act on user objects when loaded from the database. |
| hook_user_delete |
drupal/ |
Respond to user deletion. |
| hook_user_cancel |
drupal/ |
Act on user account cancellations. |
| hook_user_cancel_methods_alter |
drupal/ |
Modify account cancellation methods. |
| hook_user_operations |
drupal/ |
Add mass user operations. |
| hook_user_categories |
drupal/ |
Define a list of user settings or profile information categories. |
| hook_user_presave |
drupal/ |
A user account is about to be created or updated. |
| hook_user_insert |
drupal/ |
A user account was created. |
| hook_user_update |
drupal/ |
A user account was updated. |
| hook_user_login |
drupal/ |
The user just logged in. |
| hook_user_logout |
drupal/ |
The user just logged out. |
| hook_user_view |
drupal/ |
The user's account information is being displayed. |
| hook_user_view_alter |
drupal/ |
The user was built; the module may modify the structured content. |
| hook_user_role_presave |
drupal/ |
Act on a user role being inserted or updated. |
| hook_user_role_insert |
drupal/ |
Respond to creation of a new user role. |
| hook_user_role_update |
drupal/ |
Respond to updates to a user role. |
| hook_user_role_delete |
drupal/ |
Respond to user role deletion. |
Sub-Topics
| Name |
Location |
Description |
|---|---|---|
| Callbacks |
drupal/ |
Callback function signatures. |
| Field Types API |
drupal/ |
Define field types. |
| Field Widget API |
drupal/ |
Define Field API widget types. |
| Field Formatter API |
drupal/ |
Define Field API formatter types. |