Functions - main - drupal

Primary tabs

Title Deprecated File name Summary Direct uses Strings
hook_locale_translation_projects_alter core/modules/locale/locale.api.php Alter the list of projects to be updated by locale's interface translation.
hook_local_tasks_alter core/lib/Drupal/Core/Menu/menu.api.php Alter local tasks plugins.
hook_mail core/core.api.php Prepares a message based on parameters.
hook_mail_alter core/core.api.php Alter an email message created with MailManagerInterface->mail().
hook_mail_backend_info_alter core/core.api.php Alter the list of mail backend plugin definitions.
hook_media_source_info_alter core/modules/media/media.api.php Alters the information provided in \Drupal\media\Annotation\MediaSource.
hook_menu_links_discovered_alter core/lib/Drupal/Core/Menu/menu.api.php Alters all the menu links discovered by the menu link plugin manager.
hook_menu_local_actions_alter core/lib/Drupal/Core/Menu/menu.api.php Alter local actions plugins.
hook_menu_local_tasks_alter core/lib/Drupal/Core/Menu/menu.api.php Alter local tasks displayed on the page before they are rendered.
hook_migrate_MIGRATION_ID_prepare_row core/modules/migrate/migrate.api.php Allows adding data to a row for a migration with the specified ID.
hook_migrate_prepare_row core/modules/migrate/migrate.api.php Allows adding data to a row before processing it.
hook_migration_plugins_alter core/modules/migrate/migrate.api.php Allows altering the list of discovered migration plugins.
hook_modules_installed core/lib/Drupal/Core/Extension/module.api.php Perform necessary actions after modules are installed. 1
hook_modules_uninstalled core/lib/Drupal/Core/Extension/module.api.php Perform necessary actions after modules are uninstalled. 1
hook_module_implements_alter core/lib/Drupal/Core/Extension/module.api.php Alter the registry of modules implementing a hook.
hook_module_preinstall core/lib/Drupal/Core/Extension/module.api.php Perform necessary actions before a module is installed. 1
hook_module_preuninstall core/lib/Drupal/Core/Extension/module.api.php Perform necessary actions before a module is uninstalled. 1
hook_navigation_content_top core/modules/navigation/navigation.api.php Provide content for Navigation content_top section.
hook_navigation_content_top_alter core/modules/navigation/navigation.api.php Alter replacement values for placeholder tokens.
hook_navigation_defaults core/modules/navigation/navigation.api.php Provides default content for the Navigation bar.
hook_navigation_menu_link_tree_alter core/modules/navigation/navigation.api.php Alter the content of a given Navigation menu link tree.
hook_node_access_records core/modules/node/node.api.php Set permissions for a node to be written to the database.
hook_node_access_records_alter core/modules/node/node.api.php Alter permissions for a node before it is written to the database.
hook_node_grants core/modules/node/node.api.php Inform the node access system what permissions the user has.
hook_node_grants_alter core/modules/node/node.api.php Alter user access rules when trying to view, edit or delete a node.
hook_node_links_alter core/modules/node/node.api.php Alter the links of a node.
hook_node_search_ranking core/modules/node/node.api.php Provide additional methods of scoring for core search results for nodes.
hook_node_search_result core/modules/node/node.api.php Act on a node being displayed as a search result.
hook_node_update_index core/modules/node/node.api.php Act on a node being indexed for searching.
hook_oembed_resource_url_alter core/modules/media/media.api.php Alters an oEmbed resource URL before it is fetched.
hook_options_list_alter core/modules/options/options.api.php Alters the list of options to be displayed for a field.
hook_page_attachments core/lib/Drupal/Core/Render/theme.api.php Add attachments (typically assets) to a page before it is rendered. 1
hook_page_attachments_alter core/lib/Drupal/Core/Render/theme.api.php Alter attachments (typically assets) to a page before it is rendered. 1
hook_page_bottom core/lib/Drupal/Core/Render/theme.api.php Add a renderable array to the bottom of the page.
hook_page_top core/lib/Drupal/Core/Render/theme.api.php Add a renderable array to the top of the page.
hook_plugin_filter_TYPE_alter core/lib/Drupal/Core/Plugin/plugin.api.php Alter the filtering of plugin definitions for a specific plugin type.
hook_plugin_filter_TYPE__CONSUMER_alter core/lib/Drupal/Core/Plugin/plugin.api.php Alter the filtering of plugin definitions for a specific type and consumer.
hook_post_update_NAME core/lib/Drupal/Core/Extension/module.api.php Executes an update which is intended to update data, like entities.
hook_preprocess core/lib/Drupal/Core/Render/theme.api.php Preprocess theme variables for templates.
hook_preprocess_HOOK core/lib/Drupal/Core/Render/theme.api.php Preprocess theme variables for a specific theme hook.
hook_query_alter core/lib/Drupal/Core/Database/database.api.php Perform alterations to a structured query.
hook_query_TAG_alter core/lib/Drupal/Core/Database/database.api.php Perform alterations to a structured query for a given tag.
hook_queue_info_alter core/core.api.php Alter cron queue information before cron runs.
hook_ranking

in drupal:11.3.0 and is removed from drupal:12.0.0. Use hook_node_search_ranking() instead.

core/modules/node/node.api.php Provide additional methods of scoring for core search results for nodes.
hook_rebuild core/core.api.php Rebuild data based upon refreshed caches.
hook_removed_post_updates core/lib/Drupal/Core/Extension/module.api.php Return an array of removed hook_post_update_NAME() function names.
hook_render_template core/lib/Drupal/Core/Render/theme.api.php Render a template using the theme engine.
hook_requirements core/lib/Drupal/Core/Extension/module.api.php Check installation requirements and do status reporting.
hook_requirements_alter core/lib/Drupal/Core/Extension/module.api.php Alters requirements data.
hook_rest_resource_alter core/modules/rest/rest.api.php Alter the resource plugin definitions.

Other projects


Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.