diff options
| author | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-11-20 09:43:43 +0000 |
|---|---|---|
| committer | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-11-20 09:43:43 +0000 |
| commit | ed4b74024a7da131d38d973ee5688a950adaf6db (patch) | |
| tree | 50e676f48ef4a9a24ef8699a361fb2598568b4a7 /includes/common.inc | |
| parent | d54e67002b84b09b5df4c5af5775054d5dedf3aa (diff) | |
| download | brdo-ed4b74024a7da131d38d973ee5688a950adaf6db.tar.gz brdo-ed4b74024a7da131d38d973ee5688a950adaf6db.tar.bz2 | |
#920600 by bojanz, solotandem: Fixed Document the deprecated parameter in entity_load()
Diffstat (limited to 'includes/common.inc')
| -rw-r--r-- | includes/common.inc | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/includes/common.inc b/includes/common.inc index 861bdf938..ce0efcf4f 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -7271,18 +7271,24 @@ function entity_create_stub_entity($entity_type, $ids) { * @see hook_entity_info() * @see DrupalEntityControllerInterface * @see DrupalDefaultEntityController + * @see EntityFieldQuery * * @param $entity_type * The entity type to load, e.g. node or user. * @param $ids * An array of entity IDs, or FALSE to load all entities. * @param $conditions - * An array of conditions in the form 'field' => $value. + * (deprecated) An associative array of conditions on the base table, where + * the keys are the database fields and the values are the values those + * fields must have. Instead, it is preferable to use EntityFieldQuery to + * retrieve a list of entity IDs loadable by this function. * @param $reset * Whether to reset the internal cache for the requested entity type. * * @return * An array of entity objects indexed by their ids. + * + * @todo Remove $conditions in Drupal 8. */ function entity_load($entity_type, $ids = FALSE, $conditions = array(), $reset = FALSE) { if ($reset) { |