public function Query::getComments

Returns a reference to the comments array for the query.

Because this method returns by reference, alter hooks may edit the comments array directly to make their changes. If just adding comments, however, the use of comment() is preferred.

Note that this method must be called by reference as well:

$comments =& $query
  ->getComments();

Return value

A reference to the comments array structure.

File

drupal/core/lib/Drupal/Core/Database/Query/Query.php, line 177

Definition of Drupal\Core\Database\Query\Query

Class

Query

Base class for query builders.

Namespace

Code

public function &getComments() {
  return $this->comments;
}