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 EntityFieldQuery::propertyOrderBy

Orders the result set by an entity-specific property.

An $entity_type must be specified by calling EntityFieldCondition::entityCondition('entity_type', $entity_type) before executing the query.

If called multiple times, the query will order by each specified column in the order this method is called.

Parameters

$column: The column on which to order.

$direction: The direction to sort. Legal values are "ASC" and "DESC".

Return value

EntityFieldQuery The called object.

File

includes/entity.inc, line 994

Class

EntityFieldQuery
Retrieves entities matching a given set of conditions.

Code

public function propertyOrderBy($column, $direction = 'ASC') {
 $this->order [] = array(
 'type' => 'property',
 'specifier' => $column,
 'direction' => $direction,
 );
 return $this;
}

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