public function QueryBase::addTag in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase::addTag()

Adds a tag to a query.

Tags are strings that identify a query. A query may have any number of tags. Tags are used to mark a query so that alter hooks may decide if they wish to take action. Tags should be all lower-case and contain only letters, numbers, and underscore, and start with a letter. That is, they should follow the same rules as PHP identifiers in general.

Parameters

$tag: The tag to add.

Return value

$this The called object.

Overrides AlterableInterface::addTag

File

core/lib/Drupal/Core/Entity/Query/QueryBase.php, line 350

Class

QueryBase

The base entity query class.

Namespace

Drupal\Core\Entity\Query

Code

public function addTag($tag) {
  $this->alterTags[$tag] = 1;
  return $this;
}