summaryrefslogtreecommitdiff
path: root/modules/update/update.api.php
diff options
context:
space:
mode:
Diffstat (limited to 'modules/update/update.api.php')
-rw-r--r--modules/update/update.api.php30
1 files changed, 15 insertions, 15 deletions
diff --git a/modules/update/update.api.php b/modules/update/update.api.php
index 87f95cac5..cb5669e32 100644
--- a/modules/update/update.api.php
+++ b/modules/update/update.api.php
@@ -2,7 +2,7 @@
/**
* @file
- * Hooks provided by the Update Status module.
+ * Hooks provided by the Update Manager module.
*/
/**
@@ -14,23 +14,22 @@
* Alter the list of projects before fetching data and comparing versions.
*
* Most modules will never need to implement this hook. It is for advanced
- * interaction with the update status module: mere mortals need not apply.
- * The primary use-case for this hook is to add projects to the list, for
- * example, to provide update status data on disabled modules and themes. A
- * contributed module might want to hide projects from the list, for example,
- * if there is a site-specific module that doesn't have any official releases,
- * that module could remove itself from this list to avoid "No available
- * releases found" warnings on the available updates report. In rare cases, a
- * module might want to alter the data associated with a project already in
- * the list.
+ * interaction with the Update Manager module. The primary use-case for this
+ * hook is to add projects to the list; for example, to provide update status
+ * data on disabled modules and themes. A contributed module might want to hide
+ * projects from the list; for example, if there is a site-specific module that
+ * doesn't have any official releases, that module could remove itself from this
+ * list to avoid "No available releases found" warnings on the available updates
+ * report. In rare cases, a module might want to alter the data associated with
+ * a project already in the list.
*
* @param $projects
* Reference to an array of the projects installed on the system. This
- * includes all the metadata documented in the comments below for each
- * project (either module or theme) that is currently enabled. The array is
- * initially populated inside update_get_projects() with the help of
- * _update_process_info_list(), so look there for examples of how to
- * populate the array with real values.
+ * includes all the metadata documented in the comments below for each project
+ * (either module or theme) that is currently enabled. The array is initially
+ * populated inside update_get_projects() with the help of
+ * _update_process_info_list(), so look there for examples of how to populate
+ * the array with real values.
*
* @see update_get_projects()
* @see _update_process_info_list()
@@ -118,6 +117,7 @@ function hook_update_status_alter(&$projects) {
* no problems, return an empty array.
*
* @see update_manager_archive_verify()
+ * @ingroup update_manager_file
*/
function hook_verify_update_archive($project, $archive_file, $directory) {
$errors = array();