function hook_query_alter in Drupal 7

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Database/database.api.php \hook_query_alter()
2. 9 core/lib/Drupal/Core/Database/database.api.php \hook_query_alter()
3. 10 core/lib/Drupal/Core/Database/database.api.php \hook_query_alter()

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

6 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 modules/simpletest/tests/database_test.module

Implements hook_query_alter().

field_test_entity_query_alter in modules/field/tests/field_test.module

Implements hook_entity_query_alter().

field_test_query_store_global_test_query_alter in modules/field/tests/field_test.module

Implements hook_query_TAG_alter() for tag 'store_global_test_query'.

search_node_tags_query_alter in modules/search/tests/search_node_tags.module

Implements hook_query_alter().

taxonomy_entity_query_alter in modules/taxonomy/taxonomy.module

Implements hook_entity_query_alter().

... See full list

File

modules/system/system.api.php, line 3318

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