This shortcode renders information about the referring affiliate, if applicable.
Pages using this shortcode should not be cached.
The shortcode is used by indicating what information about the referrer should be displayed with the
display attribute. For example, to display the name of the referring affiliate:
Supported values for the
display attribute are as follows.
a) Values taken from the affiliate entry:
name: as displayed in the Affiliate column under the Affiliates > Manage Affiliates section
id: as displayed in the Id column under Affiliates > Manage Affiliates
b) Values taken from the user account linked to the affiliate entry:
user_id: the user ID (this is not the affiliate ID)
user_login: the username
user_email: the user’s email address
user_url: the URL of the user’s website
display_name: the publicly displayed name of the user
c) The field name of any enabled affiliate registration field.
- any of the above affiliate or user fields, including
- any custom field added (see the example below)
Note that the
password field is not allowed.
display attribute is omitted, the
user_login of the referrer is displayed.
For this example, we assume that in addition to the standard registration fields, we also have defined fields for the affiliate’s company, phone number, etc.
The following example prints the referrer’s name, website, company and phone number. You can copy and paste the code below to a new page and test it after visiting an affiliate link.
You have been referred by [referrer display="name"] at [referrer display="company"].
Your referrer's website : [referrer display="user_url"]
Your referrer's phone number : [referrer display="phone"]
The above example encloses the referrer information section conditionally so that it is displayed only if the viewer has actually been referred by someone.
Please note that pages using any of the referrer shortcodes must not be cached, especially if they are shown to visitors who are not logged in on your site. If those pages were cached, the same referrer information would be shown to anyone, based on the first person to visit the page which is used to create its cached version.