Resource functions
- add_alternative_file
- copy_resource
- create_resource
- delete_alternative_file
- delete_comment
- delete_resource
- get_alternative_files
- get_edit_access
- get_related_resources
- get_resource_access
- get_resource_all_image_sizes
- get_resource_comments
- get_resource_data
- get_resource_field_data
- get_resource_log
- get_resource_path
- get_resource_types
- put_resource_data
- relate_all_resources
- replace_resource_file
- resource_file_readonly
- resource_log_last_rows
- upload_file
- upload_file_by_url
- upload_multipart
- update_related_resource
- update_resource_type
- get_resource_collections
- validate_upload_url
Collection functions
- get_user_collections
- add_resource_to_collection
- remove_resource_from_collection
- create_collection
- delete_collection
- search_public_collections
- get_collection
- save_collection
- show_hide_collection
- send_collection_to_admin
- get_featured_collections
- delete_resources_in_collection
- collection_add_resources
- collection_remove_resources
- get_collections_resource_count
- reorder_featured_collections
Search functions
IIIF
Metadata functions
User functions
System
Message functions
Plugin functions
- consentmanager_get_consents
- licensemanager_get_licenses
- consentmanager_get_consent
- consentmanager_delete_consent
- consentmanager_batch_link_unlink
- consentmanager_link_consent
- consentmanager_unlink_consent
- consentmanager_create_consent
- consentmanager_update_consent
- consentmanager_get_all_consents
- consentmanager_get_all_consents_by_collection
- consentmanager_save_file
- faces_set_node
Share functions
Tab functions
Dash functions
delete_comment
Delete a resource comment by specifying the comment ref. This function is for the removal of comments not connected to annotations.
Where the comment being deleted is part of a hierarchical structure (system config $comments_flat_view = false;) and there comments below it, the deleted comment will be hidden and shown as "Deleted". The tree will be fully deleted only once the lower level items have been removed.
* Available from version 11.0.
| Variable | Description | Data type |
|---|---|---|
| $comment_ref * | ID of the comment to be deleted. | integer |
Return values
Returns true if the operation is successful. Returns false if resource comments are disabled on the system or the user making the request has insufficient permissions to delete comments.