Membership.php
This api exposes CiviCRM membership contact records.
Table of Contents
Functions
- _civicrm_api3_membership_delete_spec() : mixed
- Adjust Metadata for Delete action.
- civicrm_api3_membership_delete() : array<string|int, mixed>
- Deletes an existing contact Membership.
- civicrm_api3_membership_create() : array<string|int, mixed>
- Create a Contact Membership.
- _civicrm_api3_membership_create_spec() : mixed
- Adjust Metadata for Create action.
- _civicrm_api3_membership_get_spec() : mixed
- Adjust Metadata for Get action.
- civicrm_api3_membership_get() : array<string|int, mixed>
- Get contact Membership record.
- _civicrm_api3_membership_relationsship_get_customv2behaviour() : array<string|int, mixed>
- Non-standard behaviour inherited from v2.
Functions
_civicrm_api3_membership_delete_spec()
Adjust Metadata for Delete action.
_civicrm_api3_membership_delete_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_membership_delete()
Deletes an existing contact Membership.
civicrm_api3_membership_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array array holding id - Id of the contact membership to be deleted.
Tags
Return values
array<string|int, mixed> —API result array.
civicrm_api3_membership_create()
Create a Contact Membership.
civicrm_api3_membership_create(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for creating a Membership for a contact. Required parameters : membership_type_id and status_id.
Parameters
- $params : array<string|int, mixed>
-
Array of name/value property values of civicrm_membership.
Tags
Return values
array<string|int, mixed> —API result array.
_civicrm_api3_membership_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_membership_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_membership_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_membership_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_membership_get()
Get contact Membership record.
civicrm_api3_membership_get(array<string|int, mixed> $params) : array<string|int, mixed>
This api will return the membership records for the contacts having membership based on the relationship with the direct members.
Parameters
- $params : array<string|int, mixed>
-
Key/value pairs for contact_id and some. options affecting the desired results; has legacy support for just passing the contact_id itself as the argument
Return values
array<string|int, mixed> —Array of all found membership property values.
_civicrm_api3_membership_relationsship_get_customv2behaviour()
Non-standard behaviour inherited from v2.
_civicrm_api3_membership_relationsship_get_customv2behaviour(array<string|int, mixed> &$params, array<string|int, mixed> $membershipValues, int $contactID) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Parameters passed into get function.
- $membershipValues : array<string|int, mixed>
- $contactID : int
Return values
array<string|int, mixed> —result for calling function