function AlterableInterface::addTag

Same name in other branches
  1. 9 core/lib/Drupal/Core/Database/Query/AlterableInterface.php \Drupal\Core\Database\Query\AlterableInterface::addTag()
  2. 8.9.x core/lib/Drupal/Core/Database/Query/AlterableInterface.php \Drupal\Core\Database\Query\AlterableInterface::addTag()
  3. 11.x core/lib/Drupal/Core/Database/Query/AlterableInterface.php \Drupal\Core\Database\Query\AlterableInterface::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.

3 methods override AlterableInterface::addTag()
QueryBase::addTag in core/lib/Drupal/Core/Entity/Query/QueryBase.php
Adds a tag to a query.
Select::addTag in core/lib/Drupal/Core/Database/Query/Select.php
Adds a tag to a query.
SelectExtender::addTag in core/lib/Drupal/Core/Database/Query/SelectExtender.php
Adds a tag to a query.

File

core/lib/Drupal/Core/Database/Query/AlterableInterface.php, line 25

Class

AlterableInterface
Interface for a query that can be manipulated via an alter hook.

Namespace

Drupal\Core\Database\Query

Code

public function addTag($tag);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.