Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #2392221 by joegraduate, er.pushpinderrana, zealfire, ClientGuy: install_run_task() and install_tasks() don't document the task structure

merge-requests/26/head
Jennifer Hodgdon 2015-04-15 00:53:33 -07:00
parent bd6bc619c2
commit 8f08dc9d13
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
includes/install.core.inc
View File

@ -362,7 +362,8 @@ function install_run_tasks(&$install_state) {
* Runs an individual installation task. * Runs an individual installation task.
* *
* @param $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 * @param $install_state
* An array of information about the current installation state. This is * An array of information about the current installation state. This is
* passed in by reference so that it can be modified by the task. * 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 * 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). * 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 * @param $install_state
* An array of information about the current installation state. * An array of information about the current installation state.
* *
* @return * @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) { function install_tasks_to_perform($install_state) {
// Start with a list of all currently available tasks. // Start with a list of all currently available tasks.

12
modules/system/system.api.php
View File

@ -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 * 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 * 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 * final import of languages and the end of the installation. This is invoked
* number of custom tasks to perform during this phase. * 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 * 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 * 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 install_state_defaults()
* @see batch_set() * @see batch_set()
* @see hook_install_tasks_alter()
* @see install_tasks()
*/ */
function hook_install_tasks(&$install_state) { function hook_install_tasks(&$install_state) {
// Here, we define a variable to allow tasks to indicate that a particular, // 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. * Alter the full list of installation tasks.
* *
* This hook is invoked on the install profile in install_tasks().
*
* @param $tasks * @param $tasks
* An array of all available installation tasks, including those provided by * 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 * 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. * is selected.
* @param $install_state * @param $install_state
* An array of information about the current installation 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) { function hook_install_tasks_alter(&$tasks, $install_state) {
// Replace the "Choose language" installation task provided by Drupal core // Replace the "Choose language" installation task provided by Drupal core