MembershipBlock.php
This api exposes CiviCRM MembershipBlock records.
Table of Contents
Functions
- civicrm_api3_membership_block_create() : array<string|int, mixed>
- API to Create or update a MembershipBlock.
- _civicrm_api3_membership_block_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_membership_block_get() : array<string|int, mixed>
- Get a Membership Block.
- civicrm_api3_membership_block_delete() : array<string|int, mixed>
- Deletes an existing membership block.
Functions
civicrm_api3_membership_block_create()
API to Create or update a MembershipBlock.
civicrm_api3_membership_block_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value property values of MembershipBlock.
Return values
array<string|int, mixed> —API result array
_civicrm_api3_membership_block_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_membership_block_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_block_get()
Get a Membership Block.
civicrm_api3_membership_block_get(array<string|int, mixed> $params) : array<string|int, mixed>
This api is used for finding an existing membership block.
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value property values of civicrm_membership_block. {getfields MembershipBlock_get}
Return values
array<string|int, mixed> —API result array
civicrm_api3_membership_block_delete()
Deletes an existing membership block.
civicrm_api3_membership_block_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for deleting a membership block Required parameters : id of a membership block
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array