function hook_query_alter

7.x system.api.php hook_query_alter(QueryAlterableInterface $query)
8.x system.api.php hook_query_alter(Drupal\Core\Database\Query\AlterableInterface $query)

Perform alterations to a structured query.

Structured (aka dynamic) queries that have tags associated may be altered by any module before the query is executed.

Parameters

$query: A Query object describing the composite parts of a SQL query.

See also

hook_query_TAG_alter()

node_query_node_access_alter()

QueryAlterableInterface

SelectQueryInterface

Related topics

5 functions implement hook_query_alter()

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

database_test_query_alter in drupal/modules/simpletest/tests/database_test.module
Implements hook_query_alter().
field_test_entity_query_alter in drupal/modules/field/tests/field_test.module
Implements hook_entity_query_alter().
field_test_query_store_global_test_query_alter in drupal/modules/field/tests/field_test.module
Implements hook_query_TAG_alter() for tag 'store_global_test_query'.
search_node_tags_query_alter in drupal/modules/search/tests/search_node_tags.module
Implements hook_query_alter().
taxonomy_entity_query_alter in drupal/modules/taxonomy/taxonomy.module
Implements hook_entity_query_alter().

File

drupal/modules/system/system.api.php, line 3283
Hooks provided by Drupal core and the System module.

Code

function hook_query_alter(QueryAlterableInterface $query) {
  if ($query->hasTag('micro_limit')) {
    $query->range(0, 2);
  }
}