Filters
Op verschillende plekken in de CampaignSuite code zijn Wordpress filters ingebouwd. Deze maken het mogelijk om als developer in het thema invloed uit te oefenen op de data die op dat moment door CampaignSuite wordt gebruikt.
Alle filters kunnen het beste geplaatst worden in de functions.php van uw thema. Klik op onderstaande artikelen om de verschillende filters te bekijken.
Articles
cs_validate_contact_account
Beschrijving
Met dit filter kunt u de contact- en account-array manipuleren wanneer deze gegevens worden gemaakt vlak voordat een formulier wordt gevalideerd.
Gebruik
add_filter( 'cs_validate_contact_account', 'custom_contact_account' );
//You can also use a Gravity Forms form ID to target a specific form
add_filter( 'cs_validate_contact_account_6', 'custom_contact_account' );
Parameters
- $contact_account (array)
Deze array geeft de weergegeven contact- en account-arrays door. Deze waarde moet worden geretourneerd in de filterfunctie. - $payer (object)
Dit is het volledige object van de Payer-klasse van CampaignSuite. Dit object bevat verschillende extra informatie over de betaler.
Voorbeeld
add_filter('cs_validate_contact_account', 'validate_contact_account', 10, 2);
function validate_contact_account($contact_account, $payer)
{
[$contact, $account] = $contact_account;
if (isset($contact['Phone']) && !empty($contact['Phone'])) {
if (isMobile($contact['Phone'])) {
$contact['MobilePhone'] = $contact['Phone'];
unset($contact['Phone']);
}
}
if ($payer->accountRecordType != 'Household') {
$contact['soco__Assign_Donations_to_Parent_Account__c'] = true;
} else {
$contact['soco__Assign_Donations_to_Parent_Account__c'] = false;
}
return [$contact, $account];
}
cs_post_submit
Beschrijving
Met dit filter kunt u acties uitvoeren na een succesvolle inzending bij de Campaign Suite API.
Gebruik
add_filter('cs_post_submit', 'post_submit', 10, 1);
Parameters
- $response (object)Dit is het volledige \CampaignSuite\Render_response() klasseobject van CampaignSuite. Dit object bevat informatie over het response dat wordt geretourneerd door de CS Api.
Voorbeeld
Onderstaand voorbeeld schrijft een $_SESSION[‘orig_campaign’] waarde weg op het Salesforce object Contact.
function post_submit($response)
{
if (isset($_SESSION['orig_campaign'])) {
$sf_client = instance('Client_Salesforce');
$sf_client->update(
'Contact',
$_SESSION['orig_campaign']['contact_id'],
[
'soco__Originating_Campaign__c' => $_SESSION['orig_campaign']['campaign_id']
]
);
unset($_SESSION['orig_campaign']);
}
return $response;
}
cs_get_feed_actions
Beschrijving
Met dit filter kunt u aangepaste feedacties toevoegen aan Gravity Forms.
Gebruik
add_filter('cs_get_feed_actions', 'get_feed_actions', 10, 1);
Parameters
- $actions (array)
Dit is een array met de beschikbare acties. U kunt meer elementen aan deze array toevoegen voor aangepaste acties.
Voorbeeld
function get_feed_actions($actions)
{
$extraActions = [[
'label' => 'Maak een nieuwe Lead aan',
'value' => 'custom_lead',
'object' => 'Lead',
'objectName' => 'Lead'
]];
return array_merge($actions, $extraActions);
}
cs_get_contact_filter_fields
Beschrijving
Met dit filter kunt u meer Salesforce-contactpersoonvelden toevoegen om te controleren wanneer een contactpersoon-ID wordt doorgegeven in de URL. Standaard wordt een contactpersoon alleen gevonden op basis van een contact-ID. Voor meer veiligheid is het mogelijk om meer velden aan deze controle toe te voegen.
Gebruik
add_filter('cs_get_contact_filter_fields', 'get_contact_filter_fields', 10, 1);
Parameters
Geen
Voorbeeld
Onderstaand voorbeeld voegt het veld Contact.Email toe als extra check in de URL.
function cs_get_contact_filter_fields(){
return ['Email'];
}
cs_add_custom_json
Beschrijving
Met dit filter kunt u eigen custom JSON toevoegen aan de API call richting Findock of Converse. Deze JSON zal toegevoegd worden aan de root van het JSON object.
Gebruik
add_filter('cs_add_custom_json', 'custom_json', 10);
Voorbeeld
Onderstaand voorbeeld loopt door Woocommerce items in een winkelwagen en controleert of er Destination ID’s gezet zijn. Als dat het geval is zullen deze worden meegegeven in de JSON call naar de CampaignSuite API.
function custom_json()
{
global $woocommerce;
if ($woocommerce) {
$items = $woocommerce->cart->get_cart();
if ($items) {
$jsonItems = [];
foreach ($items as $values) {
$price = get_post_meta($values['product_id'], '_price',true);
$destination_id = get_post_meta($values['product_id'], '_sf_destination_id', true);
if ($destination_id) {
$jsonItems[] = [
'DestinationId' => $destination_id,
'Amount' => $price
];
}
}
if ($jsonItems) {
return [
'TransactionInfo' => [
'Gifts' => $jsonItems
]
];
}
}
}
return [];
}