Added documentation for order_by_metadata.

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

diff --git a/engine/lib/metadata.php b/engine/lib/metadata.php
index a5e8e22e8ba3afe201525cd468ec9ee073e28a8b..5c248e0f64efb4ce81f5220335bf6b7d7c9edeca 100644 (file)
--- a/engine/lib/metadata.php
+++ b/engine/lib/metadata.php
@@ -553,13 +553,16 @@ function find_metadata($meta_name = "", $meta_value = "", $entity_type = "", $en
  *
  *     metadata_values => NULL|ARR metadata values
  *
- *     metadata_name_value_pairs => NULL|ARR (name = 'name', value => 'value', 'operand' => '=', 'case_sensitive' => TRUE) entries.
+ *     metadata_name_value_pairs => NULL|ARR (name => 'name', value => 'value', 'operand' => '=', 'case_sensitive' => TRUE) entries.
  *     Currently if multiple values are sent via an array (value => array('value1', 'value2') the pair's operand will be forced to "IN".
  *
  *     metadata_name_value_pairs_operator => NULL|STR The operator to use for combining (name = value) OPERATOR (name = value); default AND
  *
  *     metadata_case_sensitive => BOOL Overall Case sensitive
  *
+ *     order_by_metadata => NULL|ARR (array('name' => 'metadata_text1', 'direction' => ASC|DESC, 'as' => text|integer),
+ *     Also supports array('name' => 'metadata_text1')
+ *
  * @return array
  */
 function elgg_get_entities_from_metadata(array $options = array()) {