Problem/Motivation
In #2788777: Allow a site-specific profile to be installed from existing config we excluded profiles from being installed that contain hook_install implementations.
The reasons for this was to exclude complexity, limit the scope of the issue and getting it done.
The complexity can be summarized as:
Install hooks in profiles were so far only called when a site was installed and after all the listed modules were installed and all the configuration was imported. Thus hook_install implementations were able to make a lot of assumptions about the state of the site when the code was executed.
When installing from configuration the configuration is synchronized and the install hooks are called as the extensions are installed and then the configuration is imported. In addition a profile can list modules to install which are not dependencies and, therefore, these modules can be uninstalled. The install hook can therefore also not rely on all the modules being installed.
The canonical example being standard expecting the contact module to be installed.
Right now if a profile wants to be able to be installed from config and still do something extra it has to not implement hook_install and instead define a custom install step.
Proposed resolution
to be defined
Temporary Workaround
See @slucero's comment in #25. There are differences with hook_install, see hook_install_tasks for details. This is an example of how it can be used, replacing "PROFILE" with your profile's machine name:
/**
* Implements hook_install_tasks().
*/
function PROFILE_install_tasks(&$install_state) {
$tasks = [
'PROFILE_install_content' => [
'display_name' => t('Install default content'),
'type' => 'normal',
]
];
return $tasks;
}
/**
* Callback function to install default profile content.
*
* @see PROFILE_install_tasks()
*/
function PROFILE_install_content() {
...
}
Remaining tasks
find solution
implement it
test it
commit it
User interface changes
none probably.
API changes
to be seen.
Data model changes
none.