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 the themeable group page.
File
- drupal/
core/ includes/ module.inc, line 738 - API for loading and interacting with Drupal modules.
Functions
Name |
Location | Description |
|---|---|---|
| hook_admin_paths |
drupal/ |
Define administrative paths. |
| hook_admin_paths_alter |
drupal/ |
Redefine administrative paths defined by other modules. |
| hook_aggregator_fetch_info |
drupal/ |
Specify the class, title, and short description of your fetcher plugins. |
| 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_ajax_render_alter |
drupal/ |
Alter the commands that are sent to the user through the Ajax framework. |
| hook_archiver_info |
drupal/ |
Declare archivers to the system. |
| hook_archiver_info_alter |
drupal/ |
Alter archiver information declared by other modules. |
| hook_batch_alter |
drupal/ |
Alter batch information before a batch is processed. |
| hook_block_configure |
drupal/ |
Define a configuration form for a block. |
| 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_list_alter |
drupal/ |
Act on blocks prior to rendering. |
| 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_boot |
drupal/ |
Perform setup tasks for all page requests. |
| hook_cache_flush |
drupal/ |
Flush all persistent and static caches. |
| hook_comment_delete |
drupal/ |
Respond to comment deletion. |
| hook_comment_insert |
drupal/ |
Respond to creation of a new comment. |
| hook_comment_load |
drupal/ |
Act on comments being loaded from the database. |
| hook_comment_predelete |
drupal/ |
Act before comment deletion. |
| hook_comment_presave |
drupal/ |
Act on a comment being inserted or updated. |
| hook_comment_publish |
drupal/ |
Respond to a comment being published by a moderator. |
| hook_comment_unpublish |
drupal/ |
Respond to a comment being unpublished by a moderator. |
| hook_comment_update |
drupal/ |
Respond to updates to a comment. |
| hook_comment_view |
drupal/ |
Act on a comment that is being assembled before rendering. |
| hook_comment_view_alter |
drupal/ |
Alter the results of comment_view(). |
| hook_contextual_links_view_alter |
drupal/ |
Alter a contextual links element before it is rendered. |
| hook_countries_alter |
drupal/ |
Alter the default country list. |
| hook_cron |
drupal/ |
Perform periodic actions. |
| hook_css_alter |
drupal/ |
Alter CSS files before they are output on the page. |
| hook_custom_theme |
drupal/ |
Return the machine-readable name of the theme to use for the current page. |
| hook_data_type_info |
drupal/ |
Defines available data types for the typed data API. |
| hook_data_type_info_alter |
drupal/ |
Alter available data types for typed data wrappers. |
| hook_delete |
drupal/ |
Respond to node deletion. |
| hook_disable |
drupal/ |
Perform necessary actions before module is disabled. |
| hook_drupal_goto_alter |
drupal/ |
Change the page the user is sent to by drupal_goto(). |
| 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_enable |
drupal/ |
Perform necessary actions after module is enabled. |
| hook_entity_delete |
drupal/ |
Respond to entity deletion. |
| hook_entity_field_info |
drupal/ |
Define custom entity properties. |
| hook_entity_field_info_alter |
drupal/ |
Alter defined entity properties. |
| hook_entity_info |
drupal/ |
Add to entity type definitions. |
| hook_entity_info_alter |
drupal/ |
Alter the entity type definitions. |
| hook_entity_insert |
drupal/ |
Act on entities when inserted. |
| hook_entity_load |
drupal/ |
Act on entities when loaded. |
| hook_entity_predelete |
drupal/ |
Act before entity deletion. |
| hook_entity_prepare_view |
drupal/ |
Act on entities as they are being prepared for view. |
| hook_entity_presave |
drupal/ |
Act on an entity before it is about to be created or updated. |
| hook_entity_query_alter |
drupal/ |
Alter or execute an Drupal\Core\Entity\Query\EntityQueryInterface. |
| hook_entity_update |
drupal/ |
Act on entities when updated. |
| 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_exit |
drupal/ |
Perform cleanup tasks. |
| hook_field_access |
drupal/ |
Determine whether the user has access to a given field. |
| hook_field_attach_create_bundle |
drupal/ |
Act on field_attach_create_bundle(). |
| hook_field_attach_delete |
drupal/ |
Act on field_attach_delete(). |
| hook_field_attach_delete_bundle |
drupal/ |
Act on field_attach_delete_bundle. |
| hook_field_attach_delete_revision |
drupal/ |
Act on field_attach_delete_revision(). |
| hook_field_attach_form |
drupal/ |
Act on field_attach_form(). |
| hook_field_attach_insert |
drupal/ |
Act on field_attach_insert(). |
| hook_field_attach_load |
drupal/ |
Act on field_attach_load(). |
| hook_field_attach_prepare_translation_alter |
drupal/ |
Perform alterations on field_attach_prepare_translation(). |
| hook_field_attach_preprocess_alter |
drupal/ |
Alter field_attach_preprocess() variables. |
| hook_field_attach_presave |
drupal/ |
Act on field_attach_presave(). |
| hook_field_attach_purge |
drupal/ |
Act on field_purge_data(). |
| hook_field_attach_rename_bundle |
drupal/ |
Act on field_attach_rename_bundle(). |
| hook_field_attach_submit |
drupal/ |
Act on field_attach_submit(). |
| hook_field_attach_update |
drupal/ |
Act on field_attach_update(). |
| hook_field_attach_validate |
drupal/ |
Act on field_attach_validate(). |
| hook_field_attach_view_alter |
drupal/ |
Perform alterations on field_attach_view() or field_view_field(). |
| hook_field_available_languages_alter |
drupal/ |
Alter field_available_languages() values. |
| 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_delete |
drupal/ |
Define custom delete behavior for this module's field data. |
| hook_field_delete_field |
drupal/ |
Act on a field being deleted. |
| hook_field_delete_instance |
drupal/ |
Act on a field instance being deleted. |
| hook_field_delete_revision |
drupal/ |
Define custom revision delete behavior for this module's field types. |
| hook_field_display_alter |
drupal/ |
Alters the display settings of a field before it is displayed. |
| hook_field_display_ENTITY_TYPE_alter |
drupal/ |
Alters the display settings of a field before it is displayed. |
| 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_extra_fields_display_alter |
drupal/ |
Alters the display settings of pseudo-fields before an entity is displayed. |
| hook_field_formatter_info_alter |
drupal/ |
Perform alterations on Field API formatter types. |
| hook_field_info |
drupal/ |
Define Field API field types. |
| hook_field_info_alter |
drupal/ |
Perform alterations on Field API field types. |
| hook_field_info_max_weight |
drupal/ |
Returns the maximum weight for the entity components handled by the module. |
| hook_field_insert |
drupal/ |
Define custom insert behavior for this module's field data. |
| hook_field_is_empty |
drupal/ |
Define what constitutes an empty item for a field type. |
| hook_field_language_alter |
drupal/ |
Perform alterations on field_language() values. |
| hook_field_load |
drupal/ |
Define custom load 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_prepare_view |
drupal/ |
Prepare field values prior to display. |
| hook_field_presave |
drupal/ |
Define custom presave behavior for this module's field types. |
| 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_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_schema |
drupal/ |
Define the Field API schema for a field structure. |
| hook_field_storage_create_field |
drupal/ |
Act on creation of a new field. |
| hook_field_storage_delete |
drupal/ |
Delete all field data for an entity. |
| 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_delete_revision |
drupal/ |
Delete a single revision of field data for an entity. |
| 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_info |
drupal/ |
Expose Field API storage backends. |
| hook_field_storage_info_alter |
drupal/ |
Perform alterations on Field API storage types. |
| hook_field_storage_load |
drupal/ |
Load field data for a set of entities. |
| hook_field_storage_pre_insert |
drupal/ |
Act before the storage backends insert field data. |
| hook_field_storage_pre_load |
drupal/ |
Act before the storage backends load field data. |
| hook_field_storage_pre_update |
drupal/ |
Act before the storage backends update field data. |
| hook_field_storage_purge |
drupal/ |
Remove field storage information when field data is 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_query |
drupal/ |
Execute a Drupal\Core\Entity\EntityFieldQuery. |
| hook_field_storage_update_field |
drupal/ |
Update the storage information for a field. |
| hook_field_storage_write |
drupal/ |
Write field data for an entity. |
| hook_field_update |
drupal/ |
Define custom update behavior for this module's field data. |
| hook_field_update_field |
drupal/ |
Act on a field being updated. |
| hook_field_update_forbid |
drupal/ |
Forbid a field update from occurring. |
| hook_field_update_instance |
drupal/ |
Act on a field instance being updated. |
| hook_field_validate |
drupal/ |
Validate this module's field data. |
| hook_field_widget_form_alter |
drupal/ |
Alter forms for field widgets provided by other modules. |
| hook_field_widget_info_alter |
drupal/ |
Perform alterations on Field API widget types. |
| hook_field_widget_properties_alter |
drupal/ |
Alters the widget properties of a field instance before it gets 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_widget_WIDGET_TYPE_form_alter |
drupal/ |
Alter widget forms for a specific widget provided by another module. |
| hook_filetransfer_info |
drupal/ |
Register information about FileTransfer classes provided by a module. |
| hook_filetransfer_info_alter |
drupal/ |
Alter the FileTransfer class registry. |
| hook_file_download |
drupal/ |
Control access to private file downloads and specify HTTP headers. |
| hook_file_mimetype_mapping_alter |
drupal/ |
Alter MIME type mappings used to determine MIME type from a file extension. |
| hook_file_url_alter |
drupal/ |
Alter the URL to a file. |
| hook_filter_format_disable |
drupal/ |
Perform actions when a text format has been disabled. |
| 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_info |
drupal/ |
Define content filters. |
| hook_filter_info_alter |
drupal/ |
Perform alterations on filter definitions. |
| hook_form |
drupal/ |
Display a node editing form. |
| hook_forms |
drupal/ |
Map form_ids to form builder functions. |
| hook_form_alter |
drupal/ |
Perform alterations before a form is rendered. |
| hook_form_BASE_FORM_ID_alter |
drupal/ |
Provide a form-specific alteration for shared ('base') forms. |
| hook_form_FORM_ID_alter |
drupal/ |
Provide a form-specific alteration instead of the global hook_form_alter(). |
| hook_help |
drupal/ |
Provide online user help. |
| 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_html_head_alter |
drupal/ |
Alter XHTML HEAD tags before they are rendered by drupal_get_html_head(). |
| 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_flush |
drupal/ |
Respond to image style flushing. |
| hook_image_toolkits |
drupal/ |
Define image toolkits provided by this module. |
| hook_init |
drupal/ |
Perform setup tasks for non-cached page requests. |
| hook_insert |
drupal/ |
Respond to creation of a new node. |
| hook_install |
drupal/ |
Perform setup tasks when the module is installed. |
| hook_install_tasks |
drupal/ |
Return an array of tasks to be performed by an installation profile. |
| hook_install_tasks_alter |
drupal/ |
Alter the full list of installation tasks. |
| hook_js_alter |
drupal/ |
Perform necessary alterations to the JavaScript before it is presented on the page. |
| hook_language_delete |
drupal/ |
Allow modules to react before the deletion of a language. |
| hook_language_fallback_candidates_alter |
drupal/ |
Perform alterations on the language fallback candidates. |
| hook_language_init |
drupal/ |
Allows modules to act after language initialization has been performed. |
| hook_language_insert |
drupal/ |
React to a language that was just added to the system. |
| hook_language_negotiation_info |
drupal/ |
Define language negotiation methods. |
| hook_language_negotiation_info_alter |
drupal/ |
Perform alterations on language negotiation methods. |
| hook_language_presave |
drupal/ |
React to a language about to be added or updated in the system. |
| 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_update |
drupal/ |
React to a language that was just updated in the system. |
| hook_library_info |
drupal/ |
Registers JavaScript/CSS libraries associated with a module. |
| hook_library_info_alter |
drupal/ |
Alters the JavaScript/CSS library registry. |
| hook_load |
drupal/ |
Act on nodes being loaded from the database. |
| hook_locale_translation_projects_alter |
drupal/ |
Alter the list of projects to be updated by locale's interface translation. |
| hook_mail |
drupal/ |
Prepare a message based on parameters; called from drupal_mail(). |
| hook_mail_alter |
drupal/ |
Alter an email message created with the drupal_mail() function. |
| 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_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_menu_delete |
drupal/ |
Informs modules that a custom menu was deleted. |
| hook_menu_get_item_alter |
drupal/ |
Alter a menu router item right after it has been retrieved from the database or cache. |
| hook_menu_insert |
drupal/ |
Informs modules that a custom menu was created. |
| hook_menu_link_alter |
drupal/ |
Alter the data being saved to the {menu_links} table by menu_link_save(). |
| hook_menu_link_delete |
drupal/ |
Inform modules that a menu link has been deleted. |
| 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_local_tasks_alter |
drupal/ |
Alter tabs and actions displayed on the page before they are rendered. |
| hook_menu_site_status_alter |
drupal/ |
Control site status before menu dispatching. |
| hook_menu_update |
drupal/ |
Informs modules that a custom menu was updated. |
| hook_modules_disabled |
drupal/ |
Perform necessary actions after modules are disabled. |
| hook_modules_enabled |
drupal/ |
Perform necessary actions after modules are enabled. |
| hook_modules_installed |
drupal/ |
Perform necessary actions after modules are installed. |
| hook_modules_preenable |
drupal/ |
Perform necessary actions before modules are enabled. |
| hook_modules_preinstall |
drupal/ |
Perform necessary actions before modules are installed. |
| hook_modules_uninstalled |
drupal/ |
Perform necessary actions after modules are uninstalled. |
| hook_module_implements_alter |
drupal/ |
Alter the registry of modules implementing a hook. |
| hook_node_access |
drupal/ |
Controls access to a node. |
| 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_delete |
drupal/ |
Respond to node deletion. |
| hook_node_grants |
drupal/ |
Inform the node access system what permissions the user has. |
| hook_node_grants_alter |
drupal/ |
Alter user access rules when trying to view, edit or delete a node. |
| hook_node_info |
drupal/ |
Define module-provided node types. |
| 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_operations |
drupal/ |
Add mass node operations. |
| hook_node_predelete |
drupal/ |
Act before node deletion. |
| hook_node_prepare |
drupal/ |
Act on a node object about to be shown on the add/edit form. |
| hook_node_presave |
drupal/ |
Act on a node being inserted or updated. |
| hook_node_revision_delete |
drupal/ |
Respond to deletion of a node revision. |
| hook_node_search_result |
drupal/ |
Act on a node being displayed as a search result. |
| hook_node_submit |
drupal/ |
Act on a node after validated form values have been copied to it. |
| hook_node_type_delete |
drupal/ |
Respond to node type deletion. |
| hook_node_type_insert |
drupal/ |
Respond to node type creation. |
| hook_node_type_update |
drupal/ |
Respond to node type updates. |
| 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_view |
drupal/ |
Act on a node that is being assembled before rendering. |
| hook_node_view_alter |
drupal/ |
Alter the results of node_view(). |
| 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_openid_request_alter |
drupal/ |
Allow modules to modify the OpenID request parameters. |
| hook_openid_response |
drupal/ |
Allow modules to act upon a successful OpenID login. |
| hook_overlay_child_initialize |
drupal/ |
Allow modules to act when an overlay child window is initialized. |
| hook_overlay_parent_initialize |
drupal/ |
Allow modules to act when an overlay parent window is initialized. |
| hook_page_alter |
drupal/ |
Perform alterations before a page is rendered. |
| hook_page_build |
drupal/ |
Add elements to a page before it is rendered. |
| hook_path_delete |
drupal/ |
Respond to a path being deleted. |
| hook_path_insert |
drupal/ |
Respond to a path being inserted. |
| hook_path_update |
drupal/ |
Respond to a path being updated. |
| hook_permission |
drupal/ |
Define user permissions. |
| hook_prepare |
drupal/ |
Act on a node object about to be shown on the add/edit form. |
| 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_queue_info |
drupal/ |
Declare queues holding items that need to be run periodically. |
| hook_queue_info_alter |
drupal/ |
Alter cron queue information before cron runs. |
| hook_ranking |
drupal/ |
Provide additional methods of scoring for core search results for nodes. |
| 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_rebuild |
drupal/ |
Rebuild data based upon refreshed caches. |
| 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_search_access |
drupal/ |
Define access to a custom search routine. |
| 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_info |
drupal/ |
Define a custom search type. |
| hook_search_page |
drupal/ |
Override the rendering of search results. |
| hook_search_preprocess |
drupal/ |
Preprocess text for search. |
| 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_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_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_system_info_alter |
drupal/ |
Alter the information parsed from module and theme .info files |
| hook_system_themes_page_alter |
drupal/ |
Alters theme operation links. |
| hook_system_theme_info |
drupal/ |
Return additional themes provided by modules. |
| hook_taxonomy_term_delete |
drupal/ |
Respond to taxonomy term deletion. |
| hook_taxonomy_term_insert |
drupal/ |
Act on taxonomy terms when inserted. |
| hook_taxonomy_term_load |
drupal/ |
Act on taxonomy terms when loaded. |
| hook_taxonomy_term_predelete |
drupal/ |
Act before taxonomy term deletion. |
| hook_taxonomy_term_presave |
drupal/ |
Act on taxonomy terms before they are saved. |
| hook_taxonomy_term_update |
drupal/ |
Act on taxonomy terms when updated. |
| 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_taxonomy_vocabulary_delete |
drupal/ |
Respond to taxonomy vocabulary deletion. |
| hook_taxonomy_vocabulary_insert |
drupal/ |
Act on taxonomy vocabularies when inserted. |
| hook_taxonomy_vocabulary_load |
drupal/ |
Act on taxonomy vocabularies when loaded. |
| hook_taxonomy_vocabulary_predelete |
drupal/ |
Act before taxonomy vocabulary deletion. |
| hook_taxonomy_vocabulary_presave |
drupal/ |
Act on taxonomy vocabularies before they are saved. |
| hook_taxonomy_vocabulary_update |
drupal/ |
Act on taxonomy vocabularies when updated. |
| hook_template_preprocess_default_variables_alter |
drupal/ |
Alter the default, hook-independent variables for all templates. |
| hook_test_finished |
drupal/ |
An individual test has finished. |
| hook_test_group_finished |
drupal/ |
A test group has finished. |
| hook_test_group_started |
drupal/ |
A test group has started. |
| 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_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_toolbar |
drupal/ |
Add items to the Toolbar menu. |
| hook_toolbar_alter |
drupal/ |
Alter the Toolbar menu after hook_toolbar() is invoked. |
| hook_translated_menu_link_alter |
drupal/ |
Alter a menu link after it has been translated and before it is rendered. |
| hook_transliteration_overrides_alter |
drupal/ |
Provide language-specific overrides for transliteration. |
| hook_uninstall |
drupal/ |
Remove any information that the module sets. |
| hook_update |
drupal/ |
Respond to updates to a node. |
| hook_updater_info |
drupal/ |
Provide information on Updaters (classes that can update Drupal). |
| hook_updater_info_alter |
drupal/ |
Alter the Updater information array. |
| hook_update_dependencies |
drupal/ |
Return an array of information about module update dependencies. |
| hook_update_index |
drupal/ |
Update the search index for this module. |
| hook_update_last_removed |
drupal/ |
Return a number which is no longer available as hook_update_N(). |
| hook_update_N |
drupal/ |
Perform a single update. |
| 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_url_inbound_alter |
drupal/ |
Alters inbound URL requests. |
| hook_url_outbound_alter |
drupal/ |
Alters outbound URLs. |
| hook_user_cancel |
drupal/ |
Act on user account cancellations. |
| hook_user_cancel_methods_alter |
drupal/ |
Modify account cancellation methods. |
| hook_user_delete |
drupal/ |
Respond to user deletion. |
| hook_user_format_name_alter |
drupal/ |
Alter the username that is displayed for a user. |
| hook_user_insert |
drupal/ |
Respond to creation of a new user account. |
| hook_user_load |
drupal/ |
Act on user objects when loaded from the database. |
| hook_user_login |
drupal/ |
The user just logged in. |
| hook_user_logout |
drupal/ |
The user just logged out. |
| hook_user_operations |
drupal/ |
Add mass user operations. |
| hook_user_predelete |
drupal/ |
Act before user deletion. |
| hook_user_presave |
drupal/ |
Act on a user account being inserted or updated. |
| hook_user_role_delete |
drupal/ |
Inform other modules that a user role has been deleted. |
| hook_user_role_insert |
drupal/ |
Inform other modules that a user role has been added. |
| hook_user_role_presave |
drupal/ |
Inform other modules that a user role is about to be saved. |
| hook_user_role_update |
drupal/ |
Inform other modules that a user role has been updated. |
| hook_user_update |
drupal/ |
Respond to updates to a user account. |
| 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_validate |
drupal/ |
Perform node validation before a node is created or updated. |
| hook_verify_update_archive |
drupal/ |
Verify an archive after it has been downloaded and extracted. |
| hook_view |
drupal/ |
Display a node. |
| hook_watchdog |
drupal/ |
Log an event message. |
| module_hook |
drupal/ |
Determines whether a module implements a hook. |
| module_hook_info |
drupal/ |
Retrieves a list of hooks that are declared through hook_hook_info(). |
| module_implements |
drupal/ |
Determines which modules are implementing a hook. |
| module_implements_reset |
drupal/ |
Regenerates the stored list of hook implementations. |
| 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. |
| sample_search_conditions_callback |
drupal/ |
An example conditions callback function for search. |
Sub-Topics
|
Name |
Location | Description |
|---|---|---|
| Field Formatter API |
drupal/ |
Define Field API formatter types. |
| Field Types API |
drupal/ |
Defines field, widget, display formatter, and storage types. |
| Field Widget API |
drupal/ |
Define Field API widget types. |