Integrations

Hook Reference

Hook	Description
fluent_affiliate/get_integrations	Filters the array of registered integration definitions shown in Settings → Integrations.
fluent_affiliate/get_integration_config_{integration}	Filters the configuration data for a specific integration.
fluent_affiliate/save_integration_config_{integration}	Filters the result of saving an integration's configuration.
fluent_affiliate/migrators	Filters the list of available data migrators in the Migration Tools.
fluent_affiliate/get_migration_statistics	Filters migration statistics shown in the admin migration tools.
fluent_affiliate/get_current_data_counts	Filters the current data counts displayed before a wipe operation.
fluent_affiliate/advanced_report_providers	Filters the advanced report providers available in the Reports section.
fluent_affiliate/wppayform__defaults	Filters the default field values pre-filled into a Paymattic affiliate registration form.
fluent_affiliate/user_ip	Filters the visitor IP address used for visit tracking.
fluent_affiliate/woo_menu_link_position	Filters the menu position integer for the FluentAffiliate link added to the WooCommerce My Account menu.
fluent_affiliate/woo_menu_label	Filters the label text for the FluentAffiliate link in the WooCommerce My Account menu.

fluent_affiliate/get_integrations

Filters the array of registered integration definitions shown in Settings → Integrations.

Parameters

Parameter	Type	Description
$integrations	array	Existing integration definitions keyed by slug.

Source: app/Hooks/Handlers/AdminMenuHandler.php

add_filter('fluent_affiliate/get_integrations', function($integrations) {
    $integrations['my_plugin'] = [
        'title' => 'My Plugin',
        'slug'  => 'my_plugin',
        'logo'  => MY_PLUGIN_URL . 'logo.svg',
    ];
    return $integrations;
});

fluent_affiliate/get_integration_config_{integration}

Filters the configuration data for a specific integration. The hook suffix is the integration slug.

Parameters

Parameter	Type	Description
$config	array	Saved configuration for the integration.

Source: app/Http/Controllers/IntegrationController.php

add_filter('fluent_affiliate/get_integration_config_my_plugin', function($config) {
    $config['api_key'] = get_option('my_plugin_api_key', '');
    return $config;
});

fluent_affiliate/save_integration_config_{integration}

Filters the result of saving an integration's configuration. Return a non-empty string to show as an error.

Parameters

Parameter	Type	Description
$message	string	Error message (empty string = success).
$config	array	The configuration data being saved.

Source: app/Http/Controllers/IntegrationController.php

add_filter('fluent_affiliate/save_integration_config_my_plugin', function($message, $config) {
    update_option('my_plugin_api_key', sanitize_text_field($config['api_key'] ?? ''));
    return ''; // return empty string = success
}, 10, 2);

fluent_affiliate/migrators

Filters the list of available data migrators in the Migration Tools.

Parameters

Parameter	Type	Description
$migrators	array	Migrator class definitions keyed by slug.

Source: app/Http/Controllers/MigrationController.php

add_filter('fluent_affiliate/migrators', function($migrators) {
    $migrators['my_plugin'] = ['title' => 'My Plugin Importer', 'class' => MyMigrator::class];
    return $migrators;
});

fluent_affiliate/get_migration_statistics

Filters migration statistics shown in the admin migration tools.

Parameters

Parameter	Type	Description
$stats	array	Statistics array.

Source: app/Http/Controllers/MigrationController.php

add_filter('fluent_affiliate/get_migration_statistics', function($stats) {
    $stats['my_plugin'] = MyMigrator::getStats();
    return $stats;
});

fluent_affiliate/get_current_data_counts

Filters the current data counts displayed before a wipe operation.

Parameters

Parameter	Type	Description
$counts	array	Label => count pairs.

Source: app/Http/Controllers/MigrationController.php

add_filter('fluent_affiliate/get_current_data_counts', function($counts) {
    return $counts;
});

fluent_affiliate/advanced_report_providers

Filters the advanced report providers available in the Reports section.

Parameters

Parameter	Type	Description
$providers	array	Report provider definitions.

Source: app/Http/Controllers/ReportsController.php

add_filter('fluent_affiliate/advanced_report_providers', function($providers) {
    $providers['my_report'] = ['title' => 'My Report', 'component' => 'MyReportComponent'];
    return $providers;
});

fluent_affiliate/wppayform__defaults

Filters the default field values pre-filled into a Paymattic affiliate registration form.

Parameters

Parameter	Type	Description
$fields	array	Form field defaults.
$formId	int	Paymattic form ID.

Source: app/Modules/Integrations/Paymattic/BootstrapAffiliateRegister.php

add_filter('fluent_affiliate/wppayform__defaults', function($fields, $formId) {
    return $fields;
}, 10, 2);

fluent_affiliate/user_ip

Filters the visitor IP address used for visit tracking.

Parameters

Parameter	Type	Description
$ip	string	Detected IP address.

Source: app/Services/VisitService.php

add_filter('fluent_affiliate/user_ip', function($ip) {
    // Return anonymised IP for GDPR compliance
    $parts = explode('.', $ip);
    $parts[3] = '0';
    return implode('.', $parts);
});

fluent_affiliate/woo_menu_link_position

Filters the menu position integer for the FluentAffiliate link added to the WooCommerce My Account menu.

Requires FluentAffiliate Pro.

Parameters

Parameter	Type	Description
$position	int	Menu priority/position. Lower = earlier in the list.

Source: ../fluent-affiliate-pro/app/Services/Integrations/WooCommerce/Bootstrap.php

add_filter('fluent_affiliate/woo_menu_link_position', function($position) {
    return 5; // Move to top of account menu
});

fluent_affiliate/woo_menu_label

Filters the label text for the FluentAffiliate link in the WooCommerce My Account menu.

Requires FluentAffiliate Pro.

Parameters

Parameter	Type	Description
$label	string	The menu item label. Defaults to 'Affiliate Portal'.

Source: ../fluent-affiliate-pro/app/Services/Integrations/WooCommerce/Bootstrap.php

add_filter('fluent_affiliate/woo_menu_label', function($label) {
    return __('My Referrals', 'my-plugin');
});