Hooks and filters

Affiliate plugin hooks and filters let you change how Ultimate Affiliate Pro works from your own code, without editing the plugin. Ultimate Affiliate Pro has hooks and filters for referrals, affiliates, payouts and forms. Actions run your code when something happens, such as a new referral. Filters let you change a value before the plugin uses it, such as whether a referral is saved.

Ultimate Affiliate Pro uses the standard WordPress Plugin API, so you attach code with add_action() and add_filter() as with any other plugin. To connect other apps over HTTP instead, see the REST API.

Open the Filters & Hooks reference #

Go to Ultimate Affiliate Pro›Settings›Developers. In the Hooks & Filters card, click Open the reference.

The reference is built from the plugin code each time you open it, so it always matches the version you have installed.

Choose where to add your code #

Never edit the plugin files. Updates replace them and your changes are lost. Use one of these instead:

• Child theme: add the code to functions.php of a child theme. It stays when the parent theme updates.
• Code snippets plugin: add each snippet in a plugin made for custom code, so you can turn snippets on and off from the dashboard.
• Must-use plugin: save the code as a PHP file in wp-content/mu-plugins/. It loads on every request and keeps working when you change themes.

Useful affiliate plugin hooks and filters #

These are the hooks most often used in custom code. Parameters are listed in the order the hook passes them.

Examples #

Log every new referral #

PHP

add_action( 'uap_public_action_save_referral', function ( $referral ) {
    error_log( sprintf(
        'New referral #%d for affiliate %d: %s %s',
        $referral['inserted_id'],
        $referral['affiliate_id'],
        $referral['amount'],
        $referral['currency']
    ) );
} );

Replace error_log() with your own code, for example a call to your CRM.

Skip referrals with no commission #

PHP

add_filter( 'uap_filter_insert_referral', function ( $stop, $referral ) {
    if ( (float) $referral['amount'] <= 0 ) {
        return true; // do not save this referral
    }
    return $stop;
}, 10, 2 );

Give no referrals for wholesale customers #

PHP

add_filter( 'uap_filter_before_valid_referral', function ( $is_valid, $affiliate_id, $user_id ) {
    $user = $user_id ? get_userdata( $user_id ) : false;
    if ( $user && in_array( 'wholesale_customer', (array) $user->roles, true ) ) {
        return false;
    }
    return $is_valid;
}, 10, 3 );

Change wholesale_customer to the role used on your site.

Add a note above the Register button #

PHP

add_action( 'uap_register_form_before_submit_button', function () {
    echo '<p>By joining, you agree to our affiliate terms.</p>';
} );

Run code when someone becomes an affiliate #

PHP

add_action( 'uap_save_affiliate_action', function ( $user_id, $affiliate_id ) {
    update_user_meta( $user_id, 'joined_affiliate_program', current_time( 'mysql' ) );
}, 10, 2 );

When a hook passes more than one value, set the last argument of add_action() or add_filter() to that number, as in the examples above.

Test it #

1. Add the “Log every new referral” example on a staging site with WP_DEBUG_LOG turned on.
2. Create a test referral. See Test your affiliate program.
3. Open wp-content/debug.log and check for the “New referral” line.

For a complete example that uses uap_account_page_custom_tab_content, see Add a custom tab to the Affiliate Portal. For more examples, such as auto-approving referrals or skipping bot clicks, see ready-to-use code snippets.

Frequently asked questions #

What’s next #