OptionGroup.php
This api exposes CiviCRM option groups.
OptionGroups are containers for option values.
Table of Contents
Functions
- civicrm_api3_option_group_get() : array<string|int, mixed>
- Get option groups.
- civicrm_api3_option_group_create() : array<string|int, mixed>
- Create/update option group.
- _civicrm_api3_option_group_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_option_group_delete() : array<string|int, mixed>
- Delete an existing Option Group.
Functions
civicrm_api3_option_group_get()
Get option groups.
civicrm_api3_option_group_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_option_group_create()
Create/update option group.
civicrm_api3_option_group_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed>_civicrm_api3_option_group_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_option_group_create_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_option_group_delete()
Delete an existing Option Group.
civicrm_api3_option_group_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete any existing OptionGroup given its id.
Parameters
- $params : array<string|int, mixed>
-
[id]
Return values
array<string|int, mixed> —API Result Array