You are here

public function SelectExtender::addTag in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Database/Query/SelectExtender.php \Drupal\Core\Database\Query\SelectExtender::addTag()
  2. 9 core/lib/Drupal/Core/Database/Query/SelectExtender.php \Drupal\Core\Database\Query\SelectExtender::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

3 calls to SelectExtender::addTag()
PagerSelectExtender::__construct in core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php
Constructs a PagerSelectExtender object.
SearchQuery::searchExpression in core/modules/search/src/SearchQuery.php
Sets the search query expression.
TableSortExtender::__construct in core/lib/Drupal/Core/Database/Query/TableSortExtender.php

File

core/lib/Drupal/Core/Database/Query/SelectExtender.php, line 63

Class

SelectExtender
The base extender class for Select queries.

Namespace

Drupal\Core\Database\Query

Code

public function addTag($tag) {
  $this->query
    ->addTag($tag);
  return $this;
}