UFField.php
This api exposes CiviCRM profile field.
Table of Contents
Functions
- civicrm_api3_uf_field_create() : array<string|int, mixed>
- Defines 'uf field' within a group.
- _civicrm_api3_uf_field_create_spec() : mixed
- Adjust metadata for civicrm_uf_field create.
- civicrm_api3_uf_field_get() : array<string|int, mixed>
- Returns array of uf groups (profiles) matching a set of one or more group properties.
- civicrm_api3_uf_field_delete() : array<string|int, mixed>
- Delete uf field.
- _civicrm_api3_uf_field_delete_spec() : mixed
- Field id accepted for backward compatibility - unset required on id.
Functions
civicrm_api3_uf_field_create()
Defines 'uf field' within a group.
civicrm_api3_uf_field_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> —Newly created $ufFieldArray
_civicrm_api3_uf_field_create_spec()
Adjust metadata for civicrm_uf_field create.
_civicrm_api3_uf_field_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_uf_field_get()
Returns array of uf groups (profiles) matching a set of one or more group properties.
civicrm_api3_uf_field_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>civicrm_api3_uf_field_delete()
Delete uf field.
civicrm_api3_uf_field_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_uf_field_delete_spec()
Field id accepted for backward compatibility - unset required on id.
_civicrm_api3_uf_field_delete_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>