summaryrefslogtreecommitdiff
path: root/modules/search
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2011-06-29 23:21:54 -0700
committerwebchick <webchick@24967.no-reply.drupal.org>2011-06-29 23:21:54 -0700
commit66d0e0ea7678322342b5c83ea9e14d385d6908aa (patch)
tree99fa56de4aee23663aac976359ef8be43b2cb8de /modules/search
parent2c01d0549e7908cfd9fd94cd1343b6124610e6fe (diff)
downloadbrdo-66d0e0ea7678322342b5c83ea9e14d385d6908aa.tar.gz
brdo-66d0e0ea7678322342b5c83ea9e14d385d6908aa.tar.bz2
Issue #1101678 by cwells73, jhodgdon: Fixed documentation for hook_search_status()
Diffstat (limited to 'modules/search')
-rw-r--r--modules/search/search.api.php4
1 files changed, 4 insertions, 0 deletions
diff --git a/modules/search/search.api.php b/modules/search/search.api.php
index 557a56e51..8d6e2399f 100644
--- a/modules/search/search.api.php
+++ b/modules/search/search.api.php
@@ -107,6 +107,10 @@ function hook_search_reset() {
/**
* Report the status of indexing.
*
+ * The core search module only invokes this hook on active modules.
+ * Implementing modules do not need to check whether they are active when
+ * calculating their return values.
+ *
* @return
* An associative array with the key-value pairs:
* - 'remaining': The number of items left to index.