function hook_query_alter

1 system.api.php hook_query_alter(QueryAlterableInterface $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

Hooks Allow modules to interact with the Backdrop core.

4 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 core/modules/simpletest/tests/database_test.module: Implements hook_query_alter().
field_test_entity_query_alter in core/modules/field/tests/field_test/field_test.module: Implements hook_entity_query_alter().
field_test_query_store_global_test_query_alter in core/modules/field/tests/field_test/field_test.module: Implements hook_query_TAG_alter() for tag 'store_global_test_query'.
taxonomy_test_query_alter in core/modules/simpletest/tests/taxonomy_test.module: Implements hook_query_alter().

2 invocations of hook_query_alter()

EntityReferenceSelectionHandlerGeneric::reAlterQuery in core/modules/entityreference/plugins/selection/EntityReferenceSelectionHandlerGeneric.inc: Helper method: pass a query to the alteration system again.
EntityReferenceSelectionHandlerGeneric_taxonomy_term::entityFieldQueryAlter in core/modules/entityreference/plugins/selection/EntityReferenceSelectionHandlerGeneric.inc: Implements EntityReferenceHandler::entityFieldQueryAlter().

File

core/modules/system/system.api.php, line 2817: Hooks provided by Backdrop core and the System module.

Code

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