Home › API reference › search.api.php

hook_search_status

  1. drupal
    1. 7
Versions
7 hook_search_status()

Report the status of indexing.

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

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

Code

drupal/modules/search/search.api.php, line 118

<?php
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);
}
?>