OptionValue.php
This api exposes CiviCRM option values.
Values are grouped by "OptionGroup"
Table of Contents
Functions
- civicrm_api3_option_value_get() : array<string|int, mixed>
- Retrieve one or more option values.
- _civicrm_api3_option_value_get_spec() : mixed
- Adjust Metadata for get action.
- civicrm_api3_option_value_create() : array<string|int, mixed>
- Add an OptionValue.
- _civicrm_api3_option_value_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_option_value_delete() : array<string|int, mixed>
- Deletes an existing option value.
Functions
civicrm_api3_option_value_get()
Retrieve one or more option values.
civicrm_api3_option_value_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
_civicrm_api3_option_value_get_spec()
Adjust Metadata for get action.
_civicrm_api3_option_value_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_option_value_create()
Add an OptionValue.
civicrm_api3_option_value_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array
_civicrm_api3_option_value_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_option_value_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_value_delete()
Deletes an existing option value.
civicrm_api3_option_value_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array