Updated documentation for elgg_get_entities().

git-svn-id: http://code.elgg.org/elgg/trunk@3881 36083f99-b078-4883-b0ff-0f9b5a30f544

diff --git a/engine/lib/entities.php b/engine/lib/entities.php
index fcf870e13d8c953234b5973d093b6ded1fe10850..7d8a6b90af606584b120cd9d6d62bbb289146706 100644 (file)
--- a/engine/lib/entities.php
+++ b/engine/lib/entities.php
@@ -1654,11 +1654,11 @@ function get_entity($guid) {
  *
  * @param array $options Array in format:
  *
- *     types => NULL|STR entity type
+ *     types => NULL|STR entity type (SQL: type = '$type' OR...see below...)
  *
- *     subtypes => NULL|STR entity subtype
+ *     subtypes => NULL|STR entity subtype (SQL: subtype = '$subtype'...see above)
  *
- *     type_subtype_pairs => NULL|ARR (type = '$type' AND subtype = '$subtype') pairs
+ *     type_subtype_pairs => NULL|ARR (array('type' => 'subtype')) (SQL: type = '$type' AND subtype = '$subtype') pairs
  *
  *     owner_guids => NULL|INT entity guid
  *