Product.php
This api exposes CiviCRM premium products.
Premiums are used as incentive gifts on contribution pages. Use chaining to create a premium and related products in one api call.
Table of Contents
Functions
- civicrm_api3_product_create() : array<string|int, mixed>
- Save a product.
- _civicrm_api3_product_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_product_get() : array<string|int, mixed>
- Get a product.
- civicrm_api3_product_delete() : array<string|int, mixed>
- Delete a product.
Functions
civicrm_api3_product_create()
Save a product.
civicrm_api3_product_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_product_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_product_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_product_get()
Get a product.
civicrm_api3_product_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of retrieved product property values.
civicrm_api3_product_delete()
Delete a product.
civicrm_api3_product_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array of deleted values.