1. 1.7.x includes/module.inc hooks
  2. 1.10.x core/includes/module.inc hooks
  3. 1.8.x includes/module.inc hooks
  4. 1.9.x includes/module.inc hooks

Allow modules to interact with the Backdrop core.

Backdrop'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 Backdrop, a module need simply implement a hook. When Backdrop 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 Backdrop core, they are just models that you can modify. Only the hooks implemented within modules are executed when running Backdrop.

See also

Default theme implementations

Callbacks

File

includes/module.inc, line 603
API for loading and interacting with Backdrop modules.

Functions

Namesort descending Location Description
callback_queue_worker modules/system/system.api.php Work on a single queue item.
hook_action_info modules/system/system.api.php Declares information about actions.
hook_action_info_alter modules/system/system.api.php Alters the actions declared by another module.
hook_admin_paths modules/system/system.api.php Define administrative paths.
hook_admin_paths_alter modules/system/system.api.php Redefine administrative paths defined by other modules.
hook_ajax_render_alter modules/system/system.api.php Alter the commands that are sent to the user through the Ajax framework.
hook_archiver_info modules/system/system.api.php Declare archivers to the system.
hook_archiver_info_alter modules/system/system.api.php Alter archiver information declared by other modules.
hook_autoload_info modules/system/system.api.php Define the paths to classes and interfaces within a module.
hook_autoload_info_alter modules/system/system.api.php Perform alterations to the list of classes included in the registry.
hook_backdrop_goto_alter modules/system/system.api.php Change the page the user is sent to by backdrop_goto().
hook_batch_alter modules/system/system.api.php Alter batch information before a batch is processed.
hook_block_configure modules/layout/layout.api.php Define a configuration form for a block.
hook_block_info modules/layout/layout.api.php Defines to Backdrop what blocks are provided by your module.
hook_block_info_alter modules/layout/layout.api.php Modify block definitions after loading form code.
hook_block_save modules/layout/layout.api.php Save the configuration options from hook_block_configure().
hook_block_view modules/layout/layout.api.php Return a rendered or renderable view of a block.
hook_block_view_alter modules/layout/layout.api.php Perform alterations to the content of a block.
hook_block_view_MODULE_DELTA_alter modules/layout/layout.api.php Perform alterations to a specific block.
hook_boot modules/system/system.api.php Perform setup tasks for all page requests.
hook_ckeditor_css_alter modules/ckeditor/ckeditor.api.php Modify the list of CSS files that will be added to a CKEditor instance.
hook_ckeditor_plugins modules/ckeditor/ckeditor.api.php Provides a list of CKEditor plugins.
hook_ckeditor_plugins_alter modules/ckeditor/ckeditor.api.php Modify the list of available CKEditor plugins.
hook_ckeditor_settings_alter modules/ckeditor/ckeditor.api.php Modify the raw CKEditor settings passed to the editor.
hook_comment_delete modules/comment/comment.api.php Respond to comment deletion.
hook_comment_insert modules/comment/comment.api.php Respond to creation of a new comment.
hook_comment_load modules/comment/comment.api.php Act on comments being loaded from the database.
hook_comment_predelete modules/comment/comment.api.php Act before comment deletion.
hook_comment_presave modules/comment/comment.api.php Act on a comment being inserted or updated.
hook_comment_publish modules/comment/comment.api.php Respond to a comment being published by a moderator.
hook_comment_unpublish modules/comment/comment.api.php Respond to a comment being unpublished by a moderator.
hook_comment_update modules/comment/comment.api.php Respond to updates to a comment.
hook_comment_view modules/comment/comment.api.php Act on a comment that is being assembled before rendering.
hook_comment_view_alter modules/comment/comment.api.php Alter the results of comment_view().
hook_config_create modules/config/config.api.php Respond to or modify configuration creation.
hook_config_create modules/config/config.api.php Respond to or modify configuration creation.
hook_config_create_validate modules/config/config.api.php Validate a new configuration before saving it.
hook_config_create_validate modules/config/config.api.php Validate a new configuration before saving it.
hook_config_data_validate modules/config/config.api.php Validate a configuration before saving it.
hook_config_data_validate modules/config/config.api.php Validate a configuration before saving it.
hook_config_delete modules/config/config.api.php Respond to configuration deletion.
hook_config_delete modules/config/config.api.php Respond to configuration deletion.
hook_config_delete_validate modules/config/config.api.php Validate configuration deletions before deleting them.
hook_config_delete_validate modules/config/config.api.php Validate configuration deletions before deleting them.
hook_config_info modules/config/config.api.php Provides a list of configuration prefixes for describing configuration files.
hook_config_info modules/config/config.api.php Provides a list of configuration prefixes for describing configuration files.
hook_config_update modules/config/config.api.php Respond to or modify configuration creation.
hook_config_update modules/config/config.api.php Respond to or modify configuration creation.
hook_config_update_validate modules/config/config.api.php Validate configuration changes before saving them.
hook_config_update_validate modules/config/config.api.php Validate configuration changes before saving them.
hook_contextual_links_view_alter modules/contextual/contextual.api.php Alter a contextual links element before it is rendered.
hook_countries_alter modules/system/system.api.php Alter the default country list.
hook_cron modules/system/system.api.php Perform periodic actions.
hook_cron_queue_info modules/system/system.api.php Declare queues holding items that need to be run periodically.
hook_cron_queue_info_alter modules/system/system.api.php Alter cron queue information before cron runs.
hook_css_alter modules/system/system.api.php Alter CSS files before they are output on the page.
hook_custom_theme modules/system/system.api.php Return the machine-readable name of the theme to use for the current page.
hook_delete modules/node/node.api.php Respond to node deletion.
hook_disable modules/system/system.api.php Perform necessary actions before module is disabled.
hook_editor_info modules/filter/filter.api.php Define text editors, such as WYSIWYGs or toolbars to assist with text input.
hook_editor_info_alter modules/filter/filter.api.php Perform alterations on editor definitions.
hook_element_info modules/system/system.api.php Allows modules to declare their own Form API element types and specify their default values.
hook_element_info_alter modules/system/system.api.php Alter the element type information returned from modules.
hook_enable modules/system/system.api.php Perform necessary actions after module is enabled.
hook_entity_delete modules/entity/entity.api.php Respond to entity deletion.
hook_entity_info modules/entity/entity.api.php Inform the base system and the Field API about one or more entity types.
hook_entity_info_alter modules/entity/entity.api.php Alter the entity info.
hook_entity_insert modules/entity/entity.api.php Act on entities when inserted.
hook_entity_load modules/entity/entity.api.php Act on entities when loaded.
hook_entity_predelete modules/entity/entity.api.php Act before entity deletion.
hook_entity_prepare_view modules/entity/entity.api.php Act on entities as they are being prepared for view.
hook_entity_presave modules/entity/entity.api.php Act on an entity before it is about to be created or updated.
hook_entity_query_alter modules/entity/entity.api.php Alter or execute an EntityFieldQuery.
hook_entity_update modules/entity/entity.api.php Act on entities when updated.
hook_entity_view modules/entity/entity.api.php Act on entities being assembled before rendering.
hook_entity_view_alter modules/entity/entity.api.php Alter the results of ENTITY_view().
hook_entity_view_mode_alter modules/entity/entity.api.php Change the view mode of an entity that is being displayed.
hook_entity_view_mode_delete modules/entity/entity.api.php Respond to deletion of a view mode.
hook_entity_view_mode_info modules/entity/entity.api.php Describe the view modes for entity types.
hook_entity_view_mode_info_alter modules/entity/entity.api.php Alter the view modes for entity types.
hook_entity_view_mode_insert modules/entity/entity.api.php Respond to creation of a new view mode.
hook_entity_view_mode_presave modules/entity/entity.api.php Act on a view mode before it is created or updated.
hook_entity_view_mode_update modules/entity/entity.api.php Respond to update of a view mode.
hook_exit modules/system/system.api.php Perform cleanup tasks.
hook_field_access modules/field/field.api.php Determine whether the user has access to a given field.
hook_field_attach_create_bundle modules/field/field.api.php Act on field_attach_create_bundle().
hook_field_attach_delete modules/field/field.api.php Act on field_attach_delete().
hook_field_attach_delete_bundle modules/field/field.api.php Act on field_attach_delete_bundle.
hook_field_attach_delete_revision modules/field/field.api.php Act on field_attach_delete_revision().
hook_field_attach_form modules/field/field.api.php Act on field_attach_form().
hook_field_attach_insert modules/field/field.api.php Act on field_attach_insert().
hook_field_attach_load modules/field/field.api.php Act on field_attach_load().
hook_field_attach_prepare_translation_alter modules/field/field.api.php Perform alterations on field_attach_prepare_translation().
hook_field_attach_preprocess_alter modules/field/field.api.php Alter field_attach_preprocess() variables.
hook_field_attach_presave modules/field/field.api.php Act on field_attach_presave().
hook_field_attach_purge modules/field/field.api.php Act on field_purge_data().
hook_field_attach_rename_bundle modules/field/field.api.php Act on field_attach_rename_bundle().
hook_field_attach_submit modules/field/field.api.php Act on field_attach_submit().
hook_field_attach_update modules/field/field.api.php Act on field_attach_update().
hook_field_attach_validate modules/field/field.api.php Act on field_attach_validate().
hook_field_attach_view_alter modules/field/field.api.php Perform alterations on field_attach_view() or field_view_field().
hook_field_available_languages_alter modules/field/field.api.php Alter field_available_languages() values.
hook_field_create_field modules/field/field.api.php Act on a field being created.
hook_field_create_instance modules/field/field.api.php Act on a field instance being created.
hook_field_delete modules/field/field.api.php Define custom delete behavior for this module's field data.
hook_field_delete_field modules/field/field.api.php Act on a field being deleted.
hook_field_delete_instance modules/field/field.api.php Act on a field instance being deleted.
hook_field_delete_revision modules/field/field.api.php Define custom revision delete behavior for this module's field types.
hook_field_display_alter modules/field/field.api.php Alters the display settings of a field before it gets displayed.
hook_field_display_ENTITY_TYPE_alter modules/field/field.api.php Alters the display settings of a field on a given entity type before it gets displayed.
hook_field_extra_fields modules/field/field.api.php Exposes "pseudo-field" components on fieldable entities.
hook_field_extra_fields_alter modules/field/field.api.php Alter "pseudo-field" components on fieldable entities.
hook_field_extra_fields_display_alter modules/field/field.api.php Alters the display settings of pseudo-fields before an entity is displayed.
hook_field_formatter_info modules/field/field.api.php Expose Field API formatter types.
hook_field_formatter_info_alter modules/field/field.api.php Perform alterations on Field API formatter types.
hook_field_formatter_prepare_view modules/field/field.api.php Allow formatters to load information for field values being displayed.
hook_field_formatter_view modules/field/field.api.php Build a renderable array for a field value.
hook_field_info modules/field/field.api.php Define Field API field types.
hook_field_info_alter modules/field/field.api.php Perform alterations on Field API field types.
hook_field_info_max_weight modules/field/field.api.php Returns the maximum weight for the entity components handled by the module.
hook_field_insert modules/field/field.api.php Define custom insert behavior for this module's field data.
hook_field_is_empty modules/field/field.api.php Define what constitutes an empty item for a field type.
hook_field_language_alter modules/field/field.api.php Perform alterations on field_language() values.
hook_field_load modules/field/field.api.php Define custom load behavior for this module's field types.
hook_field_prepare_translation modules/field/field.api.php Define custom prepare_translation behavior for this module's field types.
hook_field_prepare_view modules/field/field.api.php Prepare field values prior to display.
hook_field_presave modules/field/field.api.php Define custom presave behavior for this module's field types.
hook_field_purge_field modules/field/field.api.php Acts when a field record is being purged.
hook_field_purge_instance modules/field/field.api.php Acts when a field instance is being purged.
hook_field_read_field modules/field/field.api.php Act on field records being read from the database.
hook_field_read_instance modules/field/field.api.php Act on a field record being read from the database.
hook_field_schema modules/field/field.api.php Define the Field API schema for a field structure.
hook_field_storage_create_field modules/field/field.api.php Act on creation of a new field.
hook_field_storage_delete modules/field/field.api.php Delete all field data for an entity.
hook_field_storage_delete_field modules/field/field.api.php Act on deletion of a field.
hook_field_storage_delete_instance modules/field/field.api.php Act on deletion of a field instance.
hook_field_storage_delete_revision modules/field/field.api.php Delete a single revision of field data for an entity.
hook_field_storage_details modules/field/field.api.php Reveal the internal details about the storage for a field.
hook_field_storage_details_alter modules/field/field.api.php Perform alterations on Field API storage details.
hook_field_storage_info modules/field/field.api.php Expose Field API storage backends.
hook_field_storage_info_alter modules/field/field.api.php Perform alterations on Field API storage types.
hook_field_storage_load modules/field/field.api.php Load field data for a set of entities.
hook_field_storage_pre_insert modules/field/field.api.php Act before the storage backends insert field data.
hook_field_storage_pre_load modules/field/field.api.php Act before the storage backends load field data.
hook_field_storage_pre_update modules/field/field.api.php Act before the storage backends update field data.
hook_field_storage_purge modules/field/field.api.php Remove field storage information when field data is purged.
hook_field_storage_purge_field modules/field/field.api.php Remove field storage information when a field record is purged.
hook_field_storage_purge_field_instance modules/field/field.api.php Remove field storage information when a field instance is purged.
hook_field_storage_query modules/field/field.api.php Execute an EntityFieldQuery.
hook_field_storage_update_field modules/field/field.api.php Update the storage information for a field.
hook_field_storage_write modules/field/field.api.php Write field data for an entity.
hook_field_update modules/field/field.api.php Define custom update behavior for this module's field data.
hook_field_update_field modules/field/field.api.php Act on a field being updated.
hook_field_update_forbid modules/field/field.api.php Forbid a field update from occurring.
hook_field_update_instance modules/field/field.api.php Act on a field instance being updated.
hook_field_validate modules/field/field.api.php Validate this module's field data.
hook_field_widget_error modules/field/field.api.php Flag a field-level validation error.
hook_field_widget_form modules/field/field.api.php Return the form for a single field widget.
hook_field_widget_form_alter modules/field/field.api.php Alter forms for field widgets provided by other modules.
hook_field_widget_info modules/field/field.api.php Expose Field API widget types.
hook_field_widget_info_alter modules/field/field.api.php Perform alterations on Field API widget types.
hook_field_widget_properties_alter modules/field/field.api.php Alters the widget properties of a field instance before it gets displayed.
hook_field_widget_properties_ENTITY_TYPE_alter modules/field/field.api.php Alters the widget properties of a field instance on a given entity type before it gets displayed.
hook_field_widget_WIDGET_TYPE_form_alter modules/field/field.api.php Alter widget forms for a specific widget provided by another module.
hook_file_copy modules/system/system.api.php Respond to a file that has been copied.
hook_file_delete modules/system/system.api.php Respond to file deletion.
hook_file_download modules/system/system.api.php Control access to private file downloads and specify HTTP headers.
hook_file_insert modules/system/system.api.php Respond to a file being added.
hook_file_load modules/system/system.api.php Load additional information into file entities.
hook_file_mimetype_mapping_alter modules/system/system.api.php Alter MIME type mappings used to determine MIME type from a file extension.
hook_file_move modules/system/system.api.php Respond to a file that has been moved.
hook_file_predelete modules/system/system.api.php Act prior to file deletion.
hook_file_presave modules/system/system.api.php Act on a file being inserted or updated.
hook_filetransfer_info modules/system/system.api.php Register information about FileTransfer classes provided by a module.
hook_filetransfer_info_alter modules/system/system.api.php Alter the FileTransfer class registry.
hook_file_update modules/system/system.api.php Respond to a file being updated.
hook_file_url_alter modules/system/system.api.php Alter the URL to a file.
hook_file_validate modules/system/system.api.php Check that files meet a given criteria.
hook_filter_format_disable modules/filter/filter.api.php Perform actions when a text format has been disabled.
hook_filter_format_insert modules/filter/filter.api.php Perform actions when a new text format has been created.
hook_filter_format_update modules/filter/filter.api.php Perform actions when a text format has been updated.
hook_filter_info modules/filter/filter.api.php Define content filters.
hook_filter_info_alter modules/filter/filter.api.php Perform alterations on filter definitions.
hook_filter_js_settings_alter modules/filter/filter.api.php Perform alterations on the JavaScript settings that are added for filters.
hook_flush_caches modules/system/system.api.php Add a list of cache tables to be cleared.
hook_form modules/node/node.api.php Display a node editing form.
hook_form_alter modules/system/system.api.php Perform alterations before a form is rendered.
hook_form_BASE_FORM_ID_alter modules/system/system.api.php Provide a form-specific alteration for shared ('base') forms.
hook_form_FORM_ID_alter modules/system/system.api.php Provide a form-specific alteration instead of the global hook_form_alter().
hook_forms modules/system/system.api.php Map form_ids to form builder functions.
hook_hook_info modules/system/system.api.php Defines one or more hooks that are exposed by a module.
hook_hook_info_alter modules/system/system.api.php Alter information from hook_hook_info().
hook_html_head_alter modules/system/system.api.php Alter XHTML HEAD tags before they are rendered by backdrop_get_html_head().
hook_image_effect_info modules/image/image.api.php Define information about image effects provided by a module.
hook_image_effect_info_alter modules/image/image.api.php Alter the information provided in hook_image_effect_info().
hook_image_style_delete modules/image/image.api.php Respond to image style deletion.
hook_image_style_flush modules/image/image.api.php Respond to image style flushing.
hook_image_styles_alter modules/image/image.api.php Modify any image styles provided by other modules or the user.
hook_image_style_save modules/image/image.api.php Respond to image style updating.
hook_image_toolkits modules/system/system.api.php Define image toolkits provided by this module.
hook_init modules/system/system.api.php Perform setup tasks for non-cached page requests.
hook_insert modules/node/node.api.php Respond to creation of a new node.
hook_install modules/system/system.api.php Perform setup tasks when the module is installed.
hook_install_tasks modules/system/system.api.php Return an array of tasks to be performed by an installation profile.
hook_install_tasks_alter modules/system/system.api.php Alter the full list of installation tasks.
hook_js_alter modules/system/system.api.php Perform necessary alterations to the JavaScript before it is presented on the page.
hook_language_delete modules/language/language.api.php Allow modules to react before the deletion of a language.
hook_language_fallback_candidates_alter modules/system/language.api.php Perform alterations on the language fallback candidates.
hook_language_init modules/system/language.api.php Allows modules to act after language initialization has been performed.
hook_language_insert modules/language/language.api.php React to a language that was just added to the system.
hook_language_negotiation_info modules/system/language.api.php Define language negotiation providers.
hook_language_negotiation_info_alter modules/system/language.api.php Perform alterations on language negoiation providers.
hook_language_presave modules/language/language.api.php React to a language about to be added or updated in the system.
hook_language_switch_links_alter modules/system/language.api.php Perform alterations on language switcher links.
hook_language_types_info modules/system/language.api.php Define language types.
hook_language_types_info_alter modules/system/language.api.php Perform alterations on language types.
hook_language_update modules/language/language.api.php React to a language that was just updated in the system.
hook_layout_context_info modules/layout/layout.api.php Provides a list of all "contexts" available to Layout module.
hook_layout_delete modules/layout/layout.api.php Respond to a layout being deleted.
hook_layout_disable modules/layout/layout.api.php Respond to a layout being disabled.
hook_layout_enable modules/layout/layout.api.php Respond to a layout being enabled.
hook_layout_info modules/layout/layout.api.php Provides a list of layouts that can be used within the Layout module.
hook_layout_insert modules/layout/layout.api.php Respond to initial creation of a layout.
hook_layout_presave modules/layout/layout.api.php Act on a layout being inserted or updated.
hook_layout_renderer_info modules/layout/layout.api.php Returns information about Layout renderers.
hook_layout_revert modules/layout/layout.api.php Respond to a layout being reverted.
hook_layout_style_info modules/layout/layout.api.php Provides information on rendering styles that can be used by layouts.
hook_layout_update modules/layout/layout.api.php Respond to updates to a layout.
hook_library_info modules/system/system.api.php Registers JavaScript/CSS libraries associated with a module.
hook_library_info_alter modules/system/system.api.php Alters the JavaScript/CSS library registry.
hook_load modules/node/node.api.php Act on nodes being loaded from the database.
hook_locale_language_delete modules/locale/locale.api.php Allow modules to react before the deletion of a language.
hook_locale_language_insert modules/locale/locale.api.php React to a language that was just added to the system.
hook_locale_language_presave modules/locale/locale.api.php React to a language about to be added or updated in the system.
hook_locale_language_update modules/locale/locale.api.php React to a language that was just updated in the system.
hook_mail modules/system/system.api.php Prepare a message based on parameters; called from backdrop_mail().
hook_mail_alter modules/system/system.api.php Alter an email message created with the backdrop_mail() function.
hook_menu modules/system/system.api.php Define menu items and page callbacks.
hook_menu_alter modules/system/system.api.php Alter the data being saved to the {menu_router} table after hook_menu is invoked.
hook_menu_breadcrumb_alter modules/system/system.api.php Alter links in the active trail before it is rendered as the breadcrumb.
hook_menu_contextual_links_alter modules/system/system.api.php Alter contextual links before they are rendered.
hook_menu_delete modules/menu/menu.api.php Respond to a custom menu deletion.
hook_menu_get_item_alter modules/system/system.api.php Alter a menu router item right after it has been retrieved from the database or cache.
hook_menu_insert modules/menu/menu.api.php Respond to a custom menu creation.
hook_menu_link_alter modules/system/system.api.php Alter the data being saved to the {menu_links} table by menu_link_save().
hook_menu_link_delete modules/system/system.api.php Inform modules that a menu link has been deleted.
hook_menu_link_insert modules/system/system.api.php Inform modules that a menu link has been created.
hook_menu_link_update modules/system/system.api.php Inform modules that a menu link has been updated.
hook_menu_local_tasks_alter modules/system/system.api.php Alter tabs and actions displayed on the page before they are rendered.
hook_menu_site_status_alter modules/system/system.api.php Control site status before menu dispatching.
hook_menu_update modules/menu/menu.api.php Respond to a custom menu update.
hook_module_implements_alter modules/system/system.api.php Alter the registry of modules implementing a hook.
hook_modules_disabled modules/system/system.api.php Perform necessary actions after modules are disabled.
hook_modules_enabled modules/system/system.api.php Perform necessary actions after modules are enabled.
hook_modules_installed modules/system/system.api.php Perform necessary actions after modules are installed.
hook_modules_preenable modules/system/system.api.php Perform necessary actions before modules are enabled.
hook_modules_preinstall modules/system/system.api.php Perform necessary actions before modules are installed.
hook_modules_uninstalled modules/system/system.api.php Perform necessary actions after modules are uninstalled.
hook_node_access modules/node/node.api.php Controls access to a node.
hook_node_access_records modules/node/node.api.php Set permissions for a node to be written to the database.
hook_node_access_records_alter modules/node/node.api.php Alter permissions for a node before it is written to the database.
hook_node_delete modules/node/node.api.php Respond to node deletion.
hook_node_grants modules/node/node.api.php Inform the node access system what permissions the user has.
hook_node_grants_alter modules/node/node.api.php Alter user access rules when trying to view, edit or delete a node.
hook_node_insert modules/node/node.api.php Respond to creation of a new node.
hook_node_load modules/node/node.api.php Act on arbitrary nodes being loaded from the database.
hook_node_predelete modules/node/node.api.php Act before node deletion.
hook_node_prepare modules/node/node.api.php Act on a node object about to be shown on the add/edit form.
hook_node_presave modules/node/node.api.php Act on a node being inserted or updated.
hook_node_revision_delete modules/node/node.api.php Respond to deletion of a node revision.
hook_node_search_result modules/node/node.api.php Act on a node being displayed as a search result.
hook_node_submit modules/node/node.api.php Act on a node after validated form values have been copied to it.
hook_node_type_delete modules/node/node.api.php Respond to node type deletion.
hook_node_type_insert modules/node/node.api.php Respond to node type creation.
hook_node_type_load modules/node/node.api.php Respond to the loading of node types.
hook_node_type_update modules/node/node.api.php Respond to node type updates.
hook_node_update modules/node/node.api.php Respond to updates to a node.
hook_node_update_index modules/node/node.api.php Act on a node being indexed for searching.
hook_node_validate modules/node/node.api.php Perform node validation before a node is created or updated.
hook_node_view modules/node/node.api.php Act on a node that is being assembled before rendering.
hook_node_view_alter modules/node/node.api.php Alter the results of node_view().
hook_page_delivery_callback_alter modules/system/system.api.php Alters the delivery callback used to send the result of the page callback to the browser.
hook_path_delete modules/path/path.api.php Respond to a path being deleted.
hook_path_insert modules/path/path.api.php Respond to a path being inserted.
hook_path_update modules/path/path.api.php Respond to a path being updated.
hook_permission modules/system/system.api.php Define user permissions.
hook_prepare modules/node/node.api.php Act on a node object about to be shown on the add/edit form.
hook_query_alter modules/system/system.api.php Perform alterations to a structured query.
hook_query_TAG_alter modules/system/system.api.php Perform alterations to a structured query for a given tag.
hook_ranking modules/node/node.api.php Provide additional methods of scoring for core search results for nodes.
hook_redirect_access modules/redirect/redirect.api.php Control access to a redirect.
hook_redirect_alter modules/redirect/redirect.api.php Act on a redirect being redirected.
hook_redirect_delete modules/redirect/redirect.api.php Respond to redirect deletion.
hook_redirect_insert modules/redirect/redirect.api.php Respond to creation of a new redirect.
hook_redirect_load modules/redirect/redirect.api.php Act on redirects being loaded from the database.
hook_redirect_load_by_source_alter modules/redirect/redirect.api.php Alter the list of redirects matching a certain source.
hook_redirect_operations modules/redirect/redirect.api.php Provide additional operations that may be done on redirects.
hook_redirect_prepare modules/redirect/redirect.api.php Act on a redirect object about to be shown on the add/edit form.
hook_redirect_presave modules/redirect/redirect.api.php Act on a redirect being inserted or updated.
hook_redirect_update modules/redirect/redirect.api.php Respond to updates to a redirect.
hook_redirect_validate modules/redirect/redirect.api.php Perform redirect validation before a redirect is created or updated.
hook_requirements modules/system/system.api.php Check installation requirements and do status reporting.
hook_schema modules/system/system.api.php Define the current version of the database schema.
hook_schema_alter modules/system/system.api.php Perform alterations to existing database schemas.
hook_search_access modules/search/search.api.php Define access to a custom search routine.
hook_search_admin modules/search/search.api.php Add elements to the search settings form.
hook_search_execute modules/search/search.api.php Execute a search for a set of key words.
hook_search_info modules/search/search.api.php Define a custom search type.
hook_search_page modules/search/search.api.php Override the rendering of search results.
hook_search_preprocess modules/search/search.api.php Preprocess text for search.
hook_search_reset modules/search/search.api.php Take action when the search index is going to be rebuilt.
hook_search_status modules/search/search.api.php Report the status of indexing.
hook_simpletest_alter modules/simpletest/simpletest.api.php Alter the list of tests.
hook_stream_wrappers modules/system/system.api.php Registers PHP stream wrapper implementations associated with a module.
hook_stream_wrappers_alter modules/system/system.api.php Alters the list of PHP stream wrapper implementations.
hook_system_info_alter modules/system/system.api.php Alter the information parsed from module and theme .info files
hook_system_theme_info modules/system/system.api.php Return additional themes provided by modules.
hook_system_themes_page_alter modules/system/system.api.php Alters theme operation links.
hook_taxonomy_term_delete modules/taxonomy/taxonomy.api.php Respond to taxonomy term deletion.
hook_taxonomy_term_insert modules/taxonomy/taxonomy.api.php Act on taxonomy terms when inserted.
hook_taxonomy_term_load modules/taxonomy/taxonomy.api.php Act on taxonomy terms when loaded.
hook_taxonomy_term_predelete modules/taxonomy/taxonomy.api.php Act before taxonomy term deletion.
hook_taxonomy_term_presave modules/taxonomy/taxonomy.api.php Act on taxonomy terms before they are saved.
hook_taxonomy_term_update modules/taxonomy/taxonomy.api.php Act on taxonomy terms when updated.
hook_taxonomy_term_view modules/taxonomy/taxonomy.api.php Act on a taxonomy term that is being assembled before rendering.
hook_taxonomy_term_view_alter modules/taxonomy/taxonomy.api.php Alter the results of taxonomy_term_view().
hook_taxonomy_vocabulary_delete modules/taxonomy/taxonomy.api.php Respond to taxonomy vocabulary deletion.
hook_taxonomy_vocabulary_insert modules/taxonomy/taxonomy.api.php Act on taxonomy vocabularies when inserted.
hook_taxonomy_vocabulary_load modules/taxonomy/taxonomy.api.php Act on taxonomy vocabularies when loaded.
hook_taxonomy_vocabulary_predelete modules/taxonomy/taxonomy.api.php Act before taxonomy vocabulary deletion.
hook_taxonomy_vocabulary_presave modules/taxonomy/taxonomy.api.php Act on taxonomy vocabularies before they are saved.
hook_taxonomy_vocabulary_update modules/taxonomy/taxonomy.api.php Act on taxonomy vocabularies when updated.
hook_test_finished modules/simpletest/simpletest.api.php An individual test has finished.
hook_test_group_finished modules/simpletest/simpletest.api.php A test group has finished.
hook_test_group_started modules/simpletest/simpletest.api.php A test group has started.
hook_theme modules/system/system.api.php Register a module (or theme's) theme implementations.
hook_theme_registry_alter modules/system/system.api.php Alter the theme registry information returned from hook_theme().
hook_timezone_countries_alter modules/system/system.api.php Alter the default timezone country list.
hook_token_info modules/system/system.api.php Provide information about available placeholder tokens and token types.
hook_token_info_alter modules/system/system.api.php Alter the metadata about available placeholder tokens and token types.
hook_tokens modules/system/system.api.php Provide replacement values for placeholder tokens.
hook_tokens_alter modules/system/system.api.php Alter replacement values for placeholder tokens.
hook_translated_menu_link_alter modules/system/system.api.php Alter a menu link after it has been translated and before it is rendered.
hook_uninstall modules/system/system.api.php Remove any information that the module sets.
hook_update modules/node/node.api.php Respond to updates to a node.
hook_update_dependencies modules/system/system.api.php Return an array of information about module update dependencies.
hook_update_index modules/search/search.api.php Update the search index for this module.
hook_update_last_removed modules/system/system.api.php Return a number which is no longer available as hook_update_N().
hook_update_N modules/system/system.api.php Perform a single update.
hook_update_projects_alter modules/update/update.api.php Alter the list of projects before fetching data and comparing versions.
hook_updater_info modules/system/system.api.php Provide information on Updaters (classes that can update Backdrop).
hook_updater_info_alter modules/system/system.api.php Alter the Updater information array.
hook_update_status_alter modules/update/update.api.php Alter the information about available updates for projects.
hook_url_inbound_alter modules/system/system.api.php Alters inbound URL requests.
hook_url_outbound_alter modules/system/system.api.php Alters outbound URLs.
hook_user_cancel modules/user/user.api.php Act on user account cancellations.
hook_user_cancel_methods_alter modules/user/user.api.php Modify account cancellation methods.
hook_user_delete modules/user/user.api.php Respond to user deletion.
hook_user_format_name_alter modules/user/user.api.php Alter the username that is displayed for a user.
hook_user_insert modules/user/user.api.php Respond to creation of a new user account.
hook_user_load modules/user/user.api.php Act on user objects when loaded from the database.
hook_user_login modules/user/user.api.php The user just logged in.
hook_user_logout modules/user/user.api.php The user just logged out.
hook_user_predelete modules/user/user.api.php Act before user deletion.
hook_user_presave modules/user/user.api.php Act on a user account being inserted or updated.
hook_user_role_delete modules/user/user.api.php Respond to user role deletion.
hook_user_role_insert modules/user/user.api.php Respond to creation of a new user role.
hook_user_role_presave modules/user/user.api.php Act on a user role being inserted or updated.
hook_user_role_update modules/user/user.api.php Respond to updates to a user role.
hook_user_update modules/user/user.api.php Respond to updates to a user account.
hook_user_view modules/user/user.api.php The user's account information is being displayed.
hook_user_view_alter modules/user/user.api.php The user was built; the module may modify the structured content.
hook_validate modules/node/node.api.php Perform node validation before a node is created or updated.
hook_verify_update_archive modules/update/update.api.php Verify an archive after it has been downloaded and extracted.
hook_view modules/node/node.api.php Display a node.
hook_watchdog modules/system/system.api.php Log an event message.
module_hook includes/module.inc Determines whether a module implements a hook.
module_hook_info includes/module.inc Retrieves a list of hooks that are declared through hook_hook_info().
module_implements includes/module.inc Determines which modules are implementing a hook.
module_implements_reset includes/module.inc Regenerate the stored list of hook implementations.
module_implements_write_cache includes/module.inc Writes the hook implementation cache.
module_invoke includes/module.inc Invokes a hook in a particular module.
module_invoke_all includes/module.inc Invokes a hook in all enabled modules that implement it.

Files

Namesort descending Location Description
config.api.php modules/config/config.api.php Documentation for hooks provided by Config module.

Sub-Topics

Namesort descending Location Description
Callbacks includes/module.inc Callback function signatures.
Field Formatter API modules/field/field.api.php Define Field API formatter types.
Field Types API modules/field/field.api.php Define field types.
Field Widget API modules/field/field.api.php Define Field API widget types.