From ed4b74024a7da131d38d973ee5688a950adaf6db Mon Sep 17 00:00:00 2001
From: Angie Byron <webchick@24967.no-reply.drupal.org>
Date: Sat, 20 Nov 2010 09:43:43 +0000
Subject: #920600 by bojanz, solotandem: Fixed Document the deprecated 
 parameter in entity_load()

---
 modules/taxonomy/taxonomy.module | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

(limited to 'modules/taxonomy')

diff --git a/modules/taxonomy/taxonomy.module b/modules/taxonomy/taxonomy.module
index edfa7d42f..e2e99a983 100644
--- a/modules/taxonomy/taxonomy.module
+++ b/modules/taxonomy/taxonomy.module
@@ -1064,14 +1064,21 @@ class TaxonomyVocabularyController extends DrupalDefaultEntityController {
  * database access if loaded again during the same page request.
  *
  * @see entity_load()
+ * @see EntityFieldQuery
  *
  * @param $tids
- *  An array of taxonomy term IDs.
+ *   An array of taxonomy term IDs.
  * @param $conditions
- *  An array of conditions to add to the query.
+ *   (deprecated) An associative array of conditions on the {taxonomy_term}
+ *   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.
  *
  * @return
- *  An array of term objects, indexed by tid.
+ *   An array of term objects, indexed by tid.
+ *
+ * @todo Remove $conditions in Drupal 8.
  */
 function taxonomy_term_load_multiple($tids = array(), $conditions = array()) {
   return entity_load('taxonomy_term', $tids, $conditions);
-- 
cgit v1.2.3