diff options
| -rw-r--r-- | includes/install.core.inc | 9 | ||||
| -rw-r--r-- | modules/system/system.api.php | 12 |
2 files changed, 17 insertions, 4 deletions
diff --git a/includes/install.core.inc b/includes/install.core.inc index 38ad72485..e5a65865c 100644 --- a/includes/install.core.inc +++ b/includes/install.core.inc @@ -362,7 +362,8 @@ function install_run_tasks(&$install_state) { * Runs an individual installation task. * * @param $task - * An array of information about the task to be run. + * An array of information about the task to be run as returned by + * hook_install_tasks(). * @param $install_state * An array of information about the current installation state. This is * passed in by reference so that it can be modified by the task. @@ -478,11 +479,15 @@ function install_run_task($task, &$install_state) { * the page request evolves (for example, if an installation profile hasn't * been selected yet, we don't yet know which profile tasks need to be run). * + * You can override this using hook_install_tasks() or + * hook_install_tasks_alter(). + * * @param $install_state * An array of information about the current installation state. * * @return - * A list of tasks to be performed, with associated metadata. + * A list of tasks to be performed, with associated metadata as returned by + * hook_install_tasks(). */ function install_tasks_to_perform($install_state) { // Start with a list of all currently available tasks. diff --git a/modules/system/system.api.php b/modules/system/system.api.php index 0af6156a4..164647b86 100644 --- a/modules/system/system.api.php +++ b/modules/system/system.api.php @@ -3715,8 +3715,9 @@ function hook_registry_files_alter(&$files, $modules) { * * Any tasks you define here will be run, in order, after the installer has * finished the site configuration step but before it has moved on to the - * final import of languages and the end of the installation. You can have any - * number of custom tasks to perform during this phase. + * final import of languages and the end of the installation. This is invoked + * by install_tasks(). You can have any number of custom tasks to perform + * during this phase. * * Each task you define here corresponds to a callback function which you must * separately define and which is called when your task is run. This function @@ -3809,6 +3810,8 @@ function hook_registry_files_alter(&$files, $modules) { * * @see install_state_defaults() * @see batch_set() + * @see hook_install_tasks_alter() + * @see install_tasks() */ function hook_install_tasks(&$install_state) { // Here, we define a variable to allow tasks to indicate that a particular, @@ -3911,6 +3914,8 @@ function hook_html_head_alter(&$head_elements) { /** * Alter the full list of installation tasks. * + * This hook is invoked on the install profile in install_tasks(). + * * @param $tasks * An array of all available installation tasks, including those provided by * Drupal core. You can modify this array to change or replace any part of @@ -3918,6 +3923,9 @@ function hook_html_head_alter(&$head_elements) { * is selected. * @param $install_state * An array of information about the current installation state. + * + * @see hook_install_tasks() + * @see install_tasks() */ function hook_install_tasks_alter(&$tasks, $install_state) { // Replace the "Choose language" installation task provided by Drupal core |