aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/plugins.php
diff options
context:
space:
mode:
authorcash <cash.costello@gmail.com>2011-09-29 19:49:01 -0400
committercash <cash.costello@gmail.com>2011-09-29 19:49:01 -0400
commit1e3c1afcacac23f4f7d34657dce6ba462b7ed97e (patch)
treec7637ecdb84e0b190cccdc3232edd818a54869e3 /engine/lib/plugins.php
parenta458ae4e0f8e5b19884860fead6e5f901b95eca4 (diff)
downloadelgg-1e3c1afcacac23f4f7d34657dce6ba462b7ed97e.tar.gz
elgg-1e3c1afcacac23f4f7d34657dce6ba462b7ed97e.tar.bz2
Fixes #3827 updated documentation on @return for elgg_get_entities* functions
Diffstat (limited to 'engine/lib/plugins.php')
-rw-r--r--engine/lib/plugins.php2
1 files changed, 1 insertions, 1 deletions
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index fd85ed9f0..365ef6fdf 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -978,7 +978,7 @@ function elgg_unset_all_plugin_settings($plugin_id = null) {
* plugin_user_setting_name_value_pairs_operator => NULL|STR The operator to use for combining
* (name = value) OPERATOR (name = value); default AND
*
- * @return mixed
+ * @return mixed int if count is true, an array of entity objects, or false on failure
*/
function elgg_get_entities_from_plugin_user_settings(array $options = array()) {
// if they're passing it don't bother