StateProvince.php
This api exposes CiviCRM states/provinces
Table of Contents
Functions
- civicrm_api3_state_province_create() : array<string|int, mixed>
- Add a state/province.
- _civicrm_api3_state_province_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_state_province_delete() : array<string|int, mixed>
- Deletes an existing state/province.
- civicrm_api3_state_province_get() : array<string|int, mixed>
- Retrieve one or more states/provinces.
Functions
civicrm_api3_state_province_create()
Add a state/province.
civicrm_api3_state_province_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Tags
Return values
array<string|int, mixed> —API result array
_civicrm_api3_state_province_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_state_province_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_state_province_delete()
Deletes an existing state/province.
civicrm_api3_state_province_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_state_province_get()
Retrieve one or more states/provinces.
civicrm_api3_state_province_get(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> —api result array