function hook_views_query_alter

Alter the query before it is executed.

Parameters

\Drupal\views\ViewExecutable $view: The view object about to be processed.

QueryPluginBase $query: The query plugin object for the query.

See also

hook_views_query_substitutions()

\Drupal\views\Plugin\views\query\Sql

Related topics

Views hooks
Hooks that allow other modules to implement the Views API.
1 function implements hook_views_query_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

views_test_data_views_query_alter in drupal/core/modules/views/tests/views_test_data/views_test_data.views_execution.inc
Implements hook_views_query_alter().
1 invocation of hook_views_query_alter()
Sql::alter in drupal/core/modules/views/lib/Drupal/views/Plugin/views/query/Sql.php
Let modules modify the query just prior to finalizing it.

File

drupal/core/modules/views/views.api.php, line 527
Describes hooks and plugins provided by the Views module.

Code

function hook_views_query_alter(ViewExecutable &$view, QueryPluginBase &$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' => '=',
          );
        }
      }
    }
  }
}