1 search.api.php hook_search_status()

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 value

An associative array with the key-value pairs::

  • 'remaining': The number of items left to index.
  • 'total': The total number of items to index.

Related topics

Hooks Allow modules to interact with the Backdrop core. Search interface The Backdrop search interface manages a global search mechanism.

File

core/modules/search/search.api.php, line 95
Hooks provided by the Search module.

Code

function hook_search_status() {
  $total = db_query('SELECT COUNT(*) FROM {node} WHERE status = 1')->fetchField();
  $remaining = db_query("SELECT COUNT(*) FROM {node} n LEFT JOIN {search_dataset} d ON d.type = 'node' AND d.sid = n.nid WHERE n.status = 1 AND d.sid IS NULL OR d.reindex <> 0")->fetchField();
  return array('remaining' => $remaining, 'total' => $total);
}