Documentation

Website.php

This api exposes CiviCRM website records.

Table of Contents

Functions

civicrm_api3_website_create()  : array<string|int, mixed>
Add an Website for a contact.
_civicrm_api3_website_create_spec()  : mixed
Adjust Metadata for Create action.
civicrm_api3_website_delete()  : array<string|int, mixed>
Deletes an existing Website.
civicrm_api3_website_get()  : array<string|int, mixed>
Retrieve one or more websites.

Functions

civicrm_api3_website_create()

Add an Website for a contact.

civicrm_api3_website_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_website_create_spec()

Adjust Metadata for Create action.

_civicrm_api3_website_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_website_delete()

Deletes an existing Website.

civicrm_api3_website_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

API result array

civicrm_api3_website_get()

Retrieve one or more websites.

civicrm_api3_website_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


        
On this page

Search results