function hook_views_query_alter

nittany7 views.api.php hook_views_query_alter(&$view, &$query)
cis7 views.api.php hook_views_query_alter(&$view, &$query)
mooc7 views.api.php hook_views_query_alter(&$view, &$query)

Alter the query before executing the query.

This hook should be placed in MODULENAME.views.inc and it will be auto-loaded. MODULENAME.views.inc must be in the directory specified by the 'path' key returned by MODULENAME_views_api(), or the same directory as the .module file, if 'path' is unspecified.

Parameters

$view: The view object about to be processed.

$query: An object describing the query.

See also

hook_views_query_substitutions()

Related topics

1 invocation of hook_views_query_alter()
views_plugin_query_default::alter in modules/contrib/views/plugins/views_plugin_query_default.inc
Let modules modify the query just prior to finalizing it.

File

modules/contrib/views/views.api.php, line 996
Describe hooks provided by the Views module.

Code

function hook_views_query_alter(&$view, &$query) {
  // (Example assuming a view with an exposed filter on node title.)
  // If the input for the title filter is a positive integer, filter against
  // node ID instead of node title.
  if ($view->name == 'my_view' && is_numeric($view->exposed_raw_input['title']) && $view->exposed_raw_input['title'] > 0) {
    // Traverse through the 'where' part of the query.
    foreach ($query->where as &$condition_group) {
      foreach ($condition_group['conditions'] as &$condition) {
        // If this is the part of the query filtering on title, chang the
        // condition to filter on node ID.
        if ($condition['field'] == 'node.title') {
          $condition = array(
            'field' => 'node.nid',
            'value' => $view->exposed_raw_input['title'],
            'operator' => '=',
          );
        }
      }
    }
  }
}