You are here

Home » API reference » Zircon Profile 8 » entity.api.php

function hook_entity_query_alter in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_query_alter()

Alter or execute an Drupal\Core\Entity\Query\EntityQueryInterface.

Parameters

\Drupal\Core\Entity\Query\QueryInterface $query: Note the $query->altered attribute which is TRUE in case the query has already been altered once. This happens with cloned queries. If there is a pager, then such a cloned query will be executed to count all elements. This query can be detected by checking for ($query->pager && $query->count), allowing the driver to return 0 from the count query and disable the pager.

Related topics

Hooks
Define functions that alter the behavior of Drupal core.

File

core/lib/Drupal/Core/Entity/entity.api.php, line 1261
Hooks and documentation related to entities.

Code

function hook_entity_query_alter(\Drupal\Core\Entity\Query\QueryInterface $query) {

  // @todo: code example.
}