Affiliate Referral Link not Displaying in Custom Email Template

[CMS911]

I created a general email template to send to new affiliate clients. I want their unique affiliate link to display in the email template. I tried using {$affiliate_referral_url} and {$referrallink} merge fields but it always displays blank.

The client I am sending it to is activated as an affiliate. Even more puzzling the client gets the monthly referrals report and it has their link in it and in that email template it uses {$affiliate_referral_url} merge field. 
 

[leemahoney3]

{$affiliate_referral_url} is only exposed to email templates under the Affiliates template group and not the General group.

You have two options:

1. Put the email template under the Affiliates template group

2. Use a hook to expose {$affiliate_referral_url} in General email templates

<?php

use WHMCS\Mail\Template;
use WHMCS\User\Client\Affiliate;

add_hook('EmailTplMergeFields', 1, static function (array $params) {
    if ($params['type'] !== 'general') {
        return [];
    }

    return ['affiliate_ref_url' => 'Affiliate Referral Url'];
});

add_hook('EmailPreSend', 1, static function (array $params) {
    $templateName = $params['messagename'];
    $check = Template::where('name', $templateName)->where('type', 'general')->count();
    if ($check !== 1) {
        return [];
    }

    $affiliateLink = Affiliate::where('clientid', $params['relid'])->first()?->getReferralLink();

    return ['affiliate_ref_url' => $affiliateLink];
});

Note: First hook adds the information about the variable to the edit template screen 

Edited November 2, 2023 by leemahoney3

[CMS911]

Thank you so much. I wasn't able to add it as an affiliate template it does not give me that option. I like your second suggestion better anyways. Where do I add this code? to which .php?

[leemahoney3]

21 minutes ago, CMS911 said:

Thank you so much. I wasn't able to add it as an affiliate template it does not give me that option. I like your second suggestion better anyways. Where do I add this code? to which .php?

Ah, didn't notice the option to create an Affiliate related email template wasn't available.

You just need to add it to a PHP file in includes/hooks (e.g. includes/hooks/add_affiliate_link_to_email_templates.php)

[CMS911]

I did as you said. While the field now shows in the general emails (see screenshot below) it still returns a blank in the actual email template when sent.

 

 

[leemahoney3]

Interesting, as it was working for me. I assume you only have one email template with the name (no duplicates) and it's in the General section? Has the client in question been activated as an affiliate?

[CMS911]

Only one template with that name. in the general section and the client is activated as an affiliate.

[CMS911]

This is still not working