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

Issue #1619482 by mr.baileys: Fix up documentation for hook_update_N

merge-requests/26/head
Jennifer Hodgdon 2012-06-18 14:18:18 -07:00
parent d5ed9164cc
commit 07e5e3e233
1 changed files with 31 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3248,33 +3248,30 @@ function hook_install() {
/** /**
* Perform a single update. * Perform a single update.
* *
* For each patch which requires a database change add a new hook_update_N() * For each change that requires one or more actions to be performed when
* which will be called by update.php. The database updates are numbered * updating a site, add a new hook_update_N(), which will be called by
* sequentially according to the version of Drupal you are compatible with. * update.php. The documentation block preceding this function is stripped of
* newlines and used as the description for the update on the pending updates
* task list. Schema updates should adhere to the
* @link http://drupal.org/node/150215 Schema API. @endlink
* *
* Schema updates should adhere to the Schema API: * Implementations of hook_update_N() are named (module name)_update_(number).
* @link http://drupal.org/node/150215 http://drupal.org/node/150215 @endlink * The numbers are composed of three parts:
* * - 1 digit for Drupal core compatibility.
* Database updates consist of 3 parts: * - 1 digit for your module's major release version (e.g., is this the 7.x-1.*
* - 1 digit for Drupal core compatibility * (1) or 7.x-2.* (2) series of your module?). This digit should be 0 for
* - 1 digit for your module's major release version (e.g. is this the 5.x-1.* (1) or 5.x-2.* (2) series of your module?) * initial porting of your module to a new Drupal core API.
* - 2 digits for sequential counting starting with 00 * - 2 digits for sequential counting, starting with 00.
*
* The 2nd digit should be 0 for initial porting of your module to a new Drupal
* core API.
* *
* Examples: * Examples:
* - mymodule_update_5200() * - mymodule_update_7000(): This is the required update for mymodule to run
* - This is the first update to get the database ready to run mymodule 5.x-2.*. * with Drupal core API 7.x when upgrading from Drupal core API 6.x.
* - mymodule_update_6000() * - mymodule_update_7100(): This is the first update to get the database ready
* - This is the required update for mymodule to run with Drupal core API 6.x. * to run mymodule 7.x-1.*.
* - mymodule_update_6100() * - mymodule_update_7200(): This is the first update to get the database ready
* - This is the first update to get the database ready to run mymodule 6.x-1.*. * to run mymodule 7.x-2.*. Users can directly update from 6.x-2.* to 7.x-2.*
* - mymodule_update_6200() * and they get all 70xx and 72xx updates, but not 71xx updates, because
* - This is the first update to get the database ready to run mymodule 6.x-2.*. * those reside in the 7.x-1.x branch only.
* Users can directly update from 5.x-2.* to 6.x-2.* and they get all 60XX
* and 62XX updates, but not 61XX updates, because those reside in the
* 6.x-1.x branch only.
* *
* A good rule of thumb is to remove updates older than two major releases of * A good rule of thumb is to remove updates older than two major releases of
* Drupal. See hook_update_last_removed() to notify Drupal about the removals. * Drupal. See hook_update_last_removed() to notify Drupal about the removals.
@ -3293,8 +3290,8 @@ function hook_install() {
* information between successive calls, and the $sandbox['#finished'] value * information between successive calls, and the $sandbox['#finished'] value
* to provide feedback regarding completion level. * to provide feedback regarding completion level.
* *
* See the batch operations page for more information on how to use the batch API: * See the batch operations page for more information on how to use the
* @link http://drupal.org/node/180528 http://drupal.org/node/180528 @endlink * @link http://drupal.org/node/180528 Batch API. @endlink
* *
* @param $sandbox * @param $sandbox
* Stores information for multipass updates. See above for more information. * Stores information for multipass updates. See above for more information.
@ -3305,9 +3302,14 @@ function hook_install() {
* reason, it will throw a PDOException. * reason, it will throw a PDOException.
* *
* @return * @return
* Optionally update hooks may return a translated string that will be displayed * Optionally, update hooks may return a translated string that will be
* to the user. If no message is returned, no message will be presented to the * displayed to the user after the update has completed. If no message is
* user. * returned, no message will be presented to the user.
*
* @see batch
* @see schemaapi
* @see hook_update_last_removed()
* @see update_get_update_list()
*/ */
function hook_update_N(&$sandbox) { function hook_update_N(&$sandbox) {
// For non-multipass updates, the signature can simply be; // For non-multipass updates, the signature can simply be;