Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function SelectQueryExtender::getGroupBy

Returns a reference to the group-by array for this query.

Because this method returns by reference, alter hooks may edit the group-by array directly to make their changes. If just adding additional grouping fields, however, the use of groupBy() is preferred.

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

$fields =& $query->getGroupBy ();

Return value

A reference to the group-by array structure.

Overrides SelectQueryInterface::getGroupBy

File

includes/database/select.inc, line 687

Class

SelectQueryExtender
The base extender class for Select queries.

Code

public function &getGroupBy() {
 return $this->query 
 ->getGroupBy ();
}

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