LocBlock.php
This api exposes CiviCRM LocBlock records.
Table of Contents
Functions
- civicrm_api3_loc_block_create() : array<string|int, mixed>
- Create or update a LocBlock.
- civicrm_api3_loc_block_get() : array<string|int, mixed>
- Returns array of loc_blocks matching a set of one or more properties.
- civicrm_api3_loc_block_delete() : array<string|int, mixed>
- Delete an existing LocBlock.
Functions
civicrm_api3_loc_block_create()
Create or update a LocBlock.
civicrm_api3_loc_block_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Name/value pairs to insert in new 'LocBlock'.
Tags
Return values
array<string|int, mixed> —API result array.
civicrm_api3_loc_block_get()
Returns array of loc_blocks matching a set of one or more properties.
civicrm_api3_loc_block_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of one or more valid property_name=>value pairs. If $params is set. as null, all loc_blocks will be returned (default limit is 25).
Return values
array<string|int, mixed> —API result array.
civicrm_api3_loc_block_delete()
Delete an existing LocBlock.
civicrm_api3_loc_block_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array containing id of the record to be deleted.
Return values
array<string|int, mixed> —API result array.