aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/annotations.php
diff options
context:
space:
mode:
authorBrett Profitt <brett.profitt@gmail.com>2012-01-22 13:02:53 -0800
committerBrett Profitt <brett.profitt@gmail.com>2012-01-22 13:02:53 -0800
commit8d62572ff8c2b5bde2c2a933c5b0268d5984a879 (patch)
tree5b1e742056957f042e7bba05479b1979b279439e /engine/lib/annotations.php
parent673a7bedf097289b2885c7bd35b2d46b612d67dc (diff)
downloadelgg-8d62572ff8c2b5bde2c2a933c5b0268d5984a879.tar.gz
elgg-8d62572ff8c2b5bde2c2a933c5b0268d5984a879.tar.bz2
Fixes #4321. Limit alone is no longer valid for batch delete operations for metadata or annotations.
Diffstat (limited to 'engine/lib/annotations.php')
-rw-r--r--engine/lib/annotations.php4
1 files changed, 3 insertions, 1 deletions
diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php
index 5049d455b..f32dee0f0 100644
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -209,9 +209,11 @@ function elgg_get_annotations(array $options = array()) {
* Deletes annotations based on $options.
*
* @warning Unlike elgg_get_annotations() this will not accept an empty options array!
+ * This requires at least one constraint: annotation_owner_guid(s),
+ * annotation_name(s), annotation_value(s), or guid(s) must be set.
*
* @param array $options An options array. {@See elgg_get_annotations()}
- * @return mixed
+ * @return mixed Null if the metadata name is invalid. Bool on success or fail.
* @since 1.8.0
*/
function elgg_delete_annotations(array $options) {