diff options
| author | cash <cash.costello@gmail.com> | 2011-11-01 21:17:21 -0400 |
|---|---|---|
| committer | cash <cash.costello@gmail.com> | 2011-11-01 21:17:21 -0400 |
| commit | 5b02eb29cb5b1e6efb27a9b8cb865bc86ef2eeea (patch) | |
| tree | 5f609eb2a59794eed47871b1c5045a4ade79c24a /engine/lib/plugins.php | |
| parent | 508fe03a44dec3a275c19fe2c63ab63fd04c0880 (diff) | |
| download | elgg-5b02eb29cb5b1e6efb27a9b8cb865bc86ef2eeea.tar.gz elgg-5b02eb29cb5b1e6efb27a9b8cb865bc86ef2eeea.tar.bz2 | |
standardized the elgg_get_entities* function @return documentation
Diffstat (limited to 'engine/lib/plugins.php')
| -rw-r--r-- | engine/lib/plugins.php | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php index fac52b152..be871d025 100644 --- a/engine/lib/plugins.php +++ b/engine/lib/plugins.php @@ -1007,7 +1007,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 int if count is true, an array of entity objects, or false on failure + * @return mixed int If count, int. If not count, array. false on errors. */ function elgg_get_entities_from_plugin_user_settings(array $options = array()) { // if they're passing it don't bother |