#920600 by bojanz, solotandem: Fixed Document the deprecated parameter in entity_load()

2 files changed, 16 insertions, 4 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) {
diff --git a/includes/file.inc b/includes/file.inc
index a685bdf32..742c20e72 100644
--- a/includes/file.inc
+++ b/includes/file.inc
@@ -519,15 +519,21 @@ function file_create_htaccess($directory, $private = TRUE) {
  * @param $fids
  *   An array of file IDs.
  * @param $conditions
- *   An array of conditions to match against the {file_managed} table.
- *   These should be supplied in the form array('field_name' =>
- *   'field_value').
+ *   (deprecated) An associative array of conditions on the {file_managed}
+ *   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 file objects, indexed by fid.
  *
  * @see hook_file_load()
  * @see file_load()
+ * @see entity_load()
+ * @see EntityFieldQuery
+ *
+ * @todo Remove $conditions in Drupal 8.
  */
 function file_load_multiple($fids = array(), $conditions = array()) {
   return entity_load('file', $fids, $conditions);