Hooks and filters in Automation Connect
Like all Charitable extensions, Charitable Automation Connect is designed to be developer-friendly, with hooks and filters that will help you customize it to your needs.
Paid Extension
Charitable Automation Connect is a premium plugin. Get it today with one of our plugin bundles.
Filters
charitable_automation_connect_languages_directory
Added in version 1.0.0
Modify the directory where extension translations are stored.
Return Value
A string representing the path to the languages directory, relative to the wp-content/plugins directory.
Arguments
$directory (string)The language directory path. Defaults to
charitable-automation-connect/languages.
charitable_webhook_subscription_failure_threshold
Added in version 1.0.0
Modify the number of times a webhook can fail to be delivered before its status is changed to Disabled.
Return Value
Integer. Defaults to 5.
Arguments
$threshold (int)The number of failures before a webhook subscription is disabled.
charitable_webhook_campaign_payload_field_value
Added in version 1.0.0
Modify the value returned for a specific field in Campaign payloads.
Return Value
Mixed.
Arguments
$value (mixed)The unfiltered value to show in the payload data.
$field_id (string)The field ID.
$campaign (Charitable_Campaign)An instance of Charitable_Campaign representing the campaign.
charitable_webhook_donation_payload_field_value
Added in version 1.0.0
Modify the value returned for a specific field in Donation payloads.
Return Value
Mixed.
Arguments
$value (mixed)The unfiltered value to show in the payload data.
$field_id (string)The field ID.
$donation (Charitable_Donation)An instance of Charitable_Donation representing the donation.
charitable_webhook_recurring_donation_payload_field_value
Added in version 1.0.0
Modify the value returned for a specific field in Recurring Donation payloads.
Return Value
Mixed.
Arguments
$value (mixed)The unfiltered value to show in the payload data.
$field_id (string)The field ID.
$recurring_donation (Charitable_Recurring_Donation)An instance of Charitable_Recurring_Donation representing the recurring donation.
charitable_webhook_campaign_payload_fields
Added in version 1.0.0
Filter the default list of campaign fields to include. Click here to see all the fields included by default.
Return Value
Array
Arguments
$fields (string[])Recurring donation fields to include.
Usage
add_filter( 'charitable_webhook_campaign_payload_fields', function( $fields ) {
unset( $fields['creator_action_required'] );
return $fields;
} );
charitable_webhook_donation_payload_fields
Added in version 1.0.0
Filter the default list of donation fields to include. Click here to see all the fields included by default.
Return Value
Array
Arguments
$fields (string[])Recurring donation fields to include.
Usage
add_filter( 'charitable_webhook_donation_payload_fields', function( $fields ) {
unset( $fields['donor_comment'] );
return $fields;
} );
charitable_webhook_recurring_donation_payload_fields
Added in version 1.0.0
Filter the default list of recurring donation fields to include. Click here to see all the fields included by default.
Return Value
Array
Arguments
$fields (string[])Recurring donation fields to include.
Usage
add_filter( 'charitable_webhook_recurring_donation_payload_fields', function( $fields ) {
unset( $fields['recurring_renewal_date'] );
return $fields;
} );
Action
charitable_automation_connect_start
Added in version 1.0.0
Hook fired when the plugin is first loaded.
Return Value
Void
Arguments
$plugin (\Charitable\Pro\AutomationConnect\Domain\Bootstrap )An instance of the plugin Bootstrap class.