function hook_module_preinstall
Same name in other branches
- 9 core/lib/Drupal/Core/Extension/module.api.php \hook_module_preinstall()
- 8.9.x core/lib/Drupal/Core/Extension/module.api.php \hook_module_preinstall()
- 10 core/lib/Drupal/Core/Extension/module.api.php \hook_module_preinstall()
Perform necessary actions before a module is installed.
Parameters
string $module: The name of the module about to be installed.
bool $is_syncing: TRUE if the module is being installed as part of a configuration import. In these cases, your hook implementation needs to carefully consider what changes, if any, it should make. For example, it should not make any changes to configuration objects or configuration entities. Those changes should be made earlier and exported so during import there's no need to do them again.
Related topics
1 string reference to 'hook_module_preinstall'
- OtherModuleInstalledHooks::modulePreinstall in core/
modules/ system/ tests/ modules/ respond_install_uninstall_hook_test/ src/ Hook/ OtherModuleInstalledHooks.php - Implements hook_module_preinstall().
1 invocation of hook_module_preinstall()
- ModuleInstaller::doInstall in core/
lib/ Drupal/ Core/ Extension/ ModuleInstaller.php - Installs a set of modules.
File
-
core/
lib/ Drupal/ Core/ Extension/ module.api.php, line 174
Code
function hook_module_preinstall($module, bool $is_syncing) : void {
my_module_cache_clear();
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.