Elgg
Version 6.0
|
Go to the source code of this file.
Functions | |
elgg_get_annotation_from_id (int $id) | |
Elgg annotations Functions to manage object annotations. More... | |
elgg_delete_annotation_by_id (int $id) | |
Deletes an annotation using its ID. More... | |
elgg_get_annotations (array $options=[]) | |
Fetch annotations or perform a calculation on them. More... | |
elgg_list_annotations (array $options=[]) | |
Returns a rendered list of annotations with pagination. More... | |
elgg_delete_annotations (array $options) | |
Deletes annotations based on $options. More... | |
elgg_annotation_exists (int $entity_guid, string $name, int $owner_guid=0) | |
Check to see if a user has already created an annotation on an object. More... | |
elgg_annotation_exists | ( | int | $entity_guid, |
string | $name, | ||
int | $owner_guid = 0 |
||
) |
Check to see if a user has already created an annotation on an object.
int | $entity_guid | Entity guid |
string | $name | Annotation name |
int | $owner_guid | Defaults to logged in user. |
Definition at line 99 of file annotations.php.
elgg_delete_annotation_by_id | ( | int | $id | ) |
Deletes an annotation using its ID.
int | $id | The annotation ID to delete. |
Definition at line 27 of file annotations.php.
elgg_delete_annotations | ( | array | $options | ) |
Deletes annotations based on $options.
array | $options | An options array. elgg_get_annotations() |
Definition at line 85 of file annotations.php.
elgg_get_annotation_from_id | ( | int | $id | ) |
Elgg annotations Functions to manage object annotations.
Get a specific annotation by its id. If you want multiple annotation objects, use elgg_get_annotations().
int | $id | The id of the annotation object being retrieved. |
Definition at line 16 of file annotations.php.
elgg_get_annotations | ( | array | $options = [] | ) |
Fetch annotations or perform a calculation on them.
Accepts all options supported by elgg_get_entities()
The default 'order_by' is 'a_table.time_created, a_table.id',
array | $options | Options |
Definition at line 50 of file annotations.php.
elgg_list_annotations | ( | array | $options = [] | ) |
Returns a rendered list of annotations with pagination.
array | $options | Annotation getter and display options. elgg_get_annotations() and elgg_list_entities(). |
Definition at line 63 of file annotations.php.