Filters
Articles
cs_validate_contact_account
Description
This filter allows you to manipulate the contact and account array when this data is created just before a form is validated.
Use
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 )
This array passes the displayed contact and account arrays. This value must be returned in the filter function. - $payer ( object )
This is the full object of the CampaignSuite Payer class. This object contains various additional information about the payer.
Example
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
Description
This filter allows you to take actions after a successful submission to the Campaign Suite API.
Use
add_filter('cs_post_submit', 'post_submit', 10, 1);
Parameters
$response ( object ) < / div>
This is the complete CampaignSuite\CampaignSuite\Render_response() class object. This object contains information about the response returned by the CS API.
Example
The example below writes a $_SESSION[‘orig_campaign’] value to the Salesforce Contact object.
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
Description
This filter allows you to add custom feed actions to Gravity Forms.
Use
add_filter('cs_get_feed_actions', 'get_feed_actions', 10, 1);
Parameters
- $actions (array)
This is an array of the available actions. You can add more elements to this array for custom actions.
Example
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
Description
With this filter, you can add more Salesforce contact fields to monitor when a contact ID is passed in the URL. By default, a contact is only found based on a contact ID. For more security it is possible to add more fields to this check.
Use
add_filter('cs_get_contact_filter_fields', 'get_contact_filter_fields', 10, 1);
Parameters
None
Example
The example below adds the Contact.Email field as an extra check in the URL.
function cs_get_contact_filter_fields(){
return ['Email'];
}
cs_add_custom_json
Description
With this filter you can add your own custom JSON to the API call to Findock or Converse. This JSON will be added to the root of the JSON object.
Use
add_filter('cs_add_custom_json', 'custom_json', 10);
Example
The example below loops through Woocommerce items in a shopping cart and checks whether Destination IDs have been set. If so, these will be passed in the JSON call to the 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 [];
}