Functions - main - drupal

Primary tabs

Title Deprecated File name Summary Direct uses Strings
hook_form_FORM_ID_alter core/lib/Drupal/Core/Form/form.api.php Provide a form-specific alteration instead of the global hook_form_alter().
hook_form_system_theme_settings_alter core/lib/Drupal/Core/Render/theme.api.php Allow themes to alter the theme-specific settings form.
hook_help core/modules/help/help.api.php Provide online user help.
hook_help_section_info_alter core/modules/help/help.api.php Perform alterations on help page section plugin definitions.
hook_help_topics_info_alter core/modules/help/help.api.php Perform alterations on help topic definitions.
hook_icon_pack_alter core/lib/Drupal/Core/Render/theme.api.php Alter icon pack definitions.
hook_image_effect_info_alter core/modules/image/image.api.php Alter the information provided in \Drupal\image\Annotation\ImageEffect.
hook_image_style_flush core/modules/image/image.api.php Respond to image style flushing.
hook_install core/lib/Drupal/Core/Extension/module.api.php Perform setup tasks when the module is installed.
hook_install_tasks core/lib/Drupal/Core/Extension/module.api.php Return an array of tasks to be performed by an installation profile.
hook_install_tasks_alter core/lib/Drupal/Core/Extension/module.api.php Alter the full list of installation tasks.
hook_jsonapi_entity_field_filter_access core/modules/jsonapi/jsonapi.api.php Restricts filtering access to the given field.
hook_jsonapi_entity_filter_access core/modules/jsonapi/jsonapi.api.php Controls access when filtering by entity data via JSON:API.
hook_jsonapi_ENTITY_TYPE_filter_access core/modules/jsonapi/jsonapi.api.php Controls access to filtering by entity data via JSON:API.
hook_js_alter core/lib/Drupal/Core/Render/theme.api.php Alters JavaScript before it is presented on the page.
hook_js_settings_alter core/lib/Drupal/Core/Render/theme.api.php Perform necessary alterations to the JavaScript settings (drupalSettings).
hook_js_settings_build core/lib/Drupal/Core/Render/theme.api.php Modify the JavaScript settings (drupalSettings).
hook_language_fallback_candidates_alter core/modules/language/language.api.php Allow modules to alter the language fallback candidates.
hook_language_fallback_candidates_OPERATION_alter core/modules/language/language.api.php Allow modules to alter the fallback candidates for specific operations.
hook_language_negotiation_info_alter core/modules/language/language.api.php Perform alterations on language negotiation methods.
hook_language_switch_links_alter core/lib/Drupal/Core/Language/language.api.php Perform alterations on language switcher links.
hook_language_types_info core/modules/language/language.api.php Define language types.
hook_language_types_info_alter core/modules/language/language.api.php Perform alterations on language types.
hook_layout_alter core/core.api.php Allow modules to alter layout plugin definitions.
hook_library_info_alter core/lib/Drupal/Core/Render/theme.api.php Alter libraries provided by an extension.
hook_library_info_build core/lib/Drupal/Core/Render/theme.api.php Add dynamic library definitions.
hook_link_alter core/lib/Drupal/Core/Utility/link.api.php Alter the parameters for links.
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_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.

Other projects


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