Documentation

SavedSearch.php

This api exposes CiviCRM saved searches.

Table of Contents

Functions

civicrm_api3_saved_search_create()  : array<string|int, mixed>
Create or update a saved search.
_civicrm_api3_saved_search_create_spec()  : mixed
civicrm_api3_saved_search_delete()  : array<string|int, mixed>
Delete an existing saved search.
civicrm_api3_saved_search_get()  : array<string|int, mixed>
Retrieve one or more saved search(es).
_civicrm_api3_saved_search_result_cleanup()  : mixed
Unserialize the form_values field in SavedSearch API results.

Functions

civicrm_api3_saved_search_create()

Create or update a saved search.

civicrm_api3_saved_search_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Associative array of property name-value pairs to insert in new saved search.

Tags
throws
CRM_Core_Exception
example

SavedSearch/Create.php Std create example.

access

public

Return values
array<string|int, mixed> —

api result array saved_search_create

_civicrm_api3_saved_search_create_spec()

_civicrm_api3_saved_search_create_spec(array<string|int, mixed> &$fields) : mixed
Parameters
$fields : array<string|int, mixed>

civicrm_api3_saved_search_delete()

Delete an existing saved search.

civicrm_api3_saved_search_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Associative array of property name-value pairs. $params['id'] should be the ID of the saved search to be deleted.

Tags
throws
CRM_Core_Exception
example

SavedSearch/Delete.php Std delete example.

access

public

Return values
array<string|int, mixed> —

api result array saved_search_delete

civicrm_api3_saved_search_get()

Retrieve one or more saved search(es).

civicrm_api3_saved_search_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

An associative array of name-value pairs.

Tags
example

SavedSearch/Get.php Std get example.

access

public

Return values
array<string|int, mixed> —

api result array saved_search_get

_civicrm_api3_saved_search_result_cleanup()

Unserialize the form_values field in SavedSearch API results.

_civicrm_api3_saved_search_result_cleanup(array<string|int, mixed> &$result) : mixed

Note: APIv4 handles serialization automatically based on metadata.

Parameters
$result : array<string|int, mixed>

API result to be cleaned up.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results