WordReplacement.php
This api exposes CiviCRM WordReplacement records.
Word replacements are used to globally alter strings in the CiviCRM UI. Note that the original source string is always English, regardless of language settings.
Table of Contents
Functions
- civicrm_api3_word_replacement_get() : array<string|int, mixed>
- Get CiviCRM Word Replacement details.
- civicrm_api3_word_replacement_create() : array<string|int, mixed>
- Create a new Word Replacement.
- _civicrm_api3_word_replacement_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_word_replacement_delete() : array<string|int, mixed>
- Delete an existing WordReplacement.
Functions
civicrm_api3_word_replacement_get()
Get CiviCRM Word Replacement details.
civicrm_api3_word_replacement_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>civicrm_api3_word_replacement_create()
Create a new Word Replacement.
civicrm_api3_word_replacement_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_word_replacement_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_word_replacement_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_word_replacement_delete()
Delete an existing WordReplacement.
civicrm_api3_word_replacement_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array containing id of the WordReplacement to be deleted.
Return values
array<string|int, mixed> —API result array