Skip to content

Feature that excludes specific emails, IP addresses and admin purchases from triggering Purchase events #3518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Feature that excludes specific emails, IP addresses and admin purchases from triggering Purchase events #3518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bdf8a9e
Add admin settings to exclude emails, IPs, and admin purchases from P…
ukilla Jul 14, 2025
1c0fd87
Skip Facebook Purchase events for admins, excluded emails and IPs bas…
ukilla Jul 14, 2025
4bfd0d6
Enhance admin settings with Select2 taggable multiselect inputs for e…
ukilla Jul 15, 2025
1b4e34f
Fix styles
ukilla Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions assets/js/admin/enhanced-settings-sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,22 @@ jQuery(document).ready(function($) {
button.prop('disabled', false);
});
});

$('#wc_facebook_excluded_emails, #wc_facebook_excluded_ips').select2({
tags: true,
tokenSeparators: [',', ' '],
width: 'resolve',
placeholder: 'Type and hit space or comma to add',
createTag: function(params) {
var term = $.trim(params.term);
if (term === '') {
return null;
}
return {
id: term,
text: term,
newTag: true
};
}
});
});
36 changes: 34 additions & 2 deletions facebook-commerce-events-tracker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class WC_Facebookcommerce_EventsTracker {
private $tracked_events;

/** @var array array with epnding events */
private $pending_events = [];
private $pending_events = array();

/** @var AAMSettings aam settings instance, used to filter advanced matching fields*/
private $aam_settings;
Expand Down Expand Up @@ -860,6 +860,38 @@ public function inject_purchase_event( $order_id ) {
return;
}

$exclude_admin = 'yes' === get_option( 'wc_facebook_exclude_admin_purchases', 'yes' );

if ( $exclude_admin && $order->get_user_id() ) {
$user = get_userdata( $order->get_user_id() );
if ( $user && in_array( 'administrator', (array) $user->roles, true ) ) {
Logger::log( "Skipping Purchase event for admin user (user ID: {$order->get_user_id()})" );
return;
}
}

$billing_email = strtolower( $order->get_billing_email() );
$order_ip = $order->get_customer_ip_address();

$excluded_emails_raw = get_option( 'wc_facebook_excluded_emails', '' );
$excluded_ips_raw = get_option( 'wc_facebook_excluded_ips', '' );

$excluded_emails_raw = is_array( $excluded_emails_raw ) ? $excluded_emails_raw : explode( ',', $excluded_emails_raw );
$excluded_ips_raw = is_array( $excluded_ips_raw ) ? $excluded_ips_raw : explode( ',', $excluded_ips_raw );

$excluded_emails = array_map( 'trim', array_map( 'strtolower', $excluded_emails_raw ) );
$excluded_ips = array_map( 'trim', $excluded_ips_raw );

if ( in_array( $billing_email, $excluded_emails, true ) ) {
Logger::log( "Skipping Purchase event for excluded email: $billing_email" );
return;
}

if ( in_array( $order_ip, $excluded_ips, true ) ) {
Logger::log( "Skipping Purchase event for excluded IP: $order_ip" );
return;
}

// Get the status of the order to ensure we track the actual purchases and not the ones that have a failed payment.
$order_state = $order->get_status();

Expand All @@ -885,7 +917,7 @@ public function inject_purchase_event( $order_id ) {

Logger::log(
'Purchase event fired for order ' . $order_id . ' by hook ' . $hook_name . '.',
[],
array(),
array(
'should_send_log_to_meta' => false,
'should_save_log_in_woocommerce' => true,
Expand Down
53 changes: 53 additions & 0 deletions includes/Admin/Settings_Screens/Shops.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,9 @@ public function enqueue_assets() {

wp_enqueue_style( 'wc-facebook-admin-shops-settings', facebook_for_woocommerce()->get_plugin_url() . '/assets/css/admin/facebook-for-woocommerce-shops.css', array(), \WC_Facebookcommerce::VERSION );

wp_enqueue_script( 'select2' );
wp_enqueue_style( 'select2' );

wp_enqueue_script(
'wc-facebook-enhanced-settings-sync',
facebook_for_woocommerce()->get_asset_build_dir_url() . '/admin/enhanced-settings-sync.js',
Expand Down Expand Up @@ -330,6 +333,18 @@ public static function get_settings_with_title_static( string $title ): array {
RolloutSwitches::SWITCH_OFFER_MANAGEMENT_ENABLED
);

$existing_emails = get_option( 'wc_facebook_excluded_emails', [] );
if ( is_string( $existing_emails ) ) {
$existing_emails = array_map( 'trim', explode( ',', $existing_emails ) );
}
$existing_email_options = array_combine( $existing_emails, $existing_emails );

$existing_ips = get_option( 'wc_facebook_excluded_ips', [] );
if ( is_string( $existing_ips ) ) {
$existing_ips = array_map( 'trim', explode( ',', $existing_ips ) );
}
$existing_ip_options = array_combine( $existing_ips, $existing_ips );

$title_array = [
'title' => $title,
'type' => 'title',
Expand All @@ -354,6 +369,44 @@ public static function get_settings_with_title_static( string $title ): array {
'desc_tip' => sprintf( __( 'Only enable this if you are experiencing problems with the plugin. <a href="%s" target="_blank">Learn more</a>.', 'facebook-for-woocommerce' ), 'https://woocommerce.com/document/facebook-for-woocommerce/#debug-tools' ),
'default' => 'no',
],

[
'title' => __( 'Exclude Emails from Purchase Events', 'facebook-for-woocommerce' ),
'desc' => __( 'Comma-separated list of email addresses. Orders from these will not trigger a Facebook Purchase event.', 'facebook-for-woocommerce' ),
'id' => 'wc_facebook_excluded_emails',
'type' => 'multiselect',
'default' => '',
'class' => 'wc-enhanced-select',
'custom_attributes' => [
'multiple' => 'multiple',
],
'tags' => true,
'css' => 'width: 50%;',
'options' => $existing_email_options,
],

[
'title' => __( 'Exclude IPs from Purchase Events', 'facebook-for-woocommerce' ),
'desc' => __( 'Comma-separated list of IP addresses. Orders from these will not trigger a Facebook Purchase event.', 'facebook-for-woocommerce' ),
'id' => 'wc_facebook_excluded_ips',
'type' => 'multiselect',
'default' => '',
'class' => 'wc-enhanced-select',
'custom_attributes' => [
'multiple' => 'multiple',
],
'tags' => true,
'css' => 'width: 50%;',
'options' => $existing_ip_options,
],

[
'title' => __( 'Exclude Admin User Purchases', 'facebook-for-woocommerce' ),
'desc' => __( 'If enabled, orders placed by admin users will not trigger a Facebook Purchase event.', 'facebook-for-woocommerce' ),
'id' => 'wc_facebook_exclude_admin_purchases',
'type' => 'checkbox',
'default' => 'no',
],
];
if ( $offer_management_enabled_by_fb ) {
$settings_without_title_and_type[] = [
Expand Down
Loading