CustomSearch.php
This api exposes CiviCRM custom search.
Table of Contents
Functions
- civicrm_api3_custom_search_get() : array<string|int, mixed>
- Retrieve custom searches.
- civicrm_api3_custom_search_create() : array<string|int, mixed>
- Add a CustomSearch.
- _civicrm_api3_custom_search_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_custom_search_delete() : array<string|int, mixed>
- Deletes an existing CustomSearch.
Functions
civicrm_api3_custom_search_get()
Retrieve custom searches.
civicrm_api3_custom_search_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
civicrm_api3_custom_search_create()
Add a CustomSearch.
civicrm_api3_custom_search_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
_civicrm_api3_custom_search_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_custom_search_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_custom_search_delete()
Deletes an existing CustomSearch.
civicrm_api3_custom_search_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array