EntityTag.php
This api exposes CiviCRM EntityTag records.
Use this api to add/remove tags from a contact/activity/etc. To create/update/delete the tags themselves, use the Tag api.
Table of Contents
Functions
- civicrm_api3_entity_tag_get() : array<string|int, mixed>
- Get entity tags.
- _civicrm_api3_entity_tag_get_spec() : mixed
- Adjust Metadata for Get action.
- civicrm_api3_entity_tag_create() : array<string|int, mixed>
- Create an entity tag.
- civicrm_api3_entity_tag_delete() : array<string|int, mixed>
- Mark entity tag as removed.
- _civicrm_api3_entity_tag_delete_spec() : mixed
- Modify metadata.
- _civicrm_api3_entity_tag_common() : array<string|int, mixed>
- Helper function for formatting tags (part of api v2 legacy).
- civicrm_api3_entity_tag_replace() : mixed
- Replace tags for an entity
Functions
civicrm_api3_entity_tag_get()
Get entity tags.
civicrm_api3_entity_tag_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_entity_tag_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_entity_tag_get_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_entity_tag_create()
Create an entity tag.
civicrm_api3_entity_tag_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_entity_tag_delete()
Mark entity tag as removed.
civicrm_api3_entity_tag_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_entity_tag_delete_spec()
Modify metadata.
_civicrm_api3_entity_tag_delete_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
_civicrm_api3_entity_tag_common()
Helper function for formatting tags (part of api v2 legacy).
_civicrm_api3_entity_tag_common(array<string|int, mixed> $params[, string $op = 'add' ]) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
- $op : string = 'add'
Return values
array<string|int, mixed>civicrm_api3_entity_tag_replace()
Replace tags for an entity
civicrm_api3_entity_tag_replace(mixed $params) : mixed
Parameters
- $params : mixed