Display & UI Customization Plugins

Available in: Post Affiliate Pro , Post Affiliate Pro Ultimate , Post Affiliate Network

Post Affiliate Pro offers a suite of display and UI customization plugins that allow you to tailor the user experience for both merchants and affiliates. These plugins provide granular control over what information is displayed, how reports are configured, and what variables are available in templates. This documentation covers the key display and UI customization plugins available in Post Affiliate Pro.

Hide Campaigns Plugin

The Hide Campaigns plugin gives merchants the ability to hide specific campaigns from the affiliate panel while keeping them fully operational for tracking purposes. This is particularly useful for internal campaigns, special promotions, or campaigns that should only be accessible to specific affiliates.

Key Features

• Campaign Visibility Control: Hide any campaign from the affiliate panel campaigns list through a simple checkbox in the campaign edit dialog
• Continued Tracking: Hidden campaigns remain fully functional for tracking clicks, sales, and commissions
• Default Affiliate Assignment: Optionally assign all commissions from hidden campaigns to a default affiliate instead of the affiliate recognized by cookie
• Lifetime Association Control: Option to skip lifetime referral creation for hidden campaigns
• Audit Logging: All visibility changes are logged for accountability

Configuration Options

When you enable the Hide Campaigns plugin, you gain access to the following configuration settings:

1. Assign commissions to default affiliate: When enabled, all commissions generated through hidden campaigns are automatically assigned to your designated default affiliate, rather than the affiliate identified through tracking cookies. This is useful for house campaigns or internal promotions.

2. Skip lifetime creation: When enabled, commissions from hidden campaigns will not create lifetime customer associations. This prevents hidden campaigns from affecting your lifetime commission structure.

How to Hide a Campaign

1. Navigate to Campaigns in the merchant panel
2. Edit the campaign you want to hide
3. In the campaign details form, check the Hide campaign option
4. Save the campaign

The campaign will immediately be hidden from all affiliate campaign lists but will continue to track and record commissions normally.

Launch your affiliate program today

Set up advanced tracking in minutes. No credit card required.

Request demo Start 30-days free trial

Affiliate Info Widget Plugin

The Affiliate Info plugin enables you to display affiliate details on any external webpage. This is valuable for creating personalized landing pages, showing referrer information to visitors, or integrating affiliate data into third-party applications.

Displayable Information

The plugin can expose the following affiliate data fields:

• Name: The affiliate’s full name
• Email: The affiliate’s email address
• Photo: The affiliate’s profile photo
• Custom Fields (1-12): Up to 12 configurable data fields that map to affiliate profile attributes
• Parent Affiliate Data: Access to the referring affiliate’s information using the parent_ prefix

Implementation

To display affiliate information on your page, use the following HTML and JavaScript structure:

<span id="papname"></span>
<script src="https://your-domain.com/plugins/AffiliateInfo/affiliateinfo.php?param=name" type="text/javascript"></script>

Replace name with any of the available parameters: name, email, photo, field1 through field12, or all to load all enabled values at once.

Security Considerations

The plugin includes important security controls:

• Only fields explicitly enabled in the plugin configuration will be returned
• Disabled fields return empty values, preventing unauthorized data exposure
• The merchant controls exactly which affiliate data can be accessed externally

Configuration

In the plugin settings, you can enable or disable each data field:

• Display affiliate name: Toggle visibility of affiliate names
• Display affiliate email: Toggle visibility of email addresses
• Display affiliate photo: Toggle visibility of profile photos
• Field 1-12: Map each field to a specific affiliate data attribute or disable it

Each field can also be configured to show parent affiliate data by selecting the corresponding parent_ option.

Affiliate Campaigns Plugin

The Affiliate Campaigns plugin extends email template capabilities by providing access to campaign data for personalized communications. This plugin adds the {$affiliatecampaigns} variable to all email templates.

Template Variable

The {$affiliatecampaigns} variable contains an associative array of all campaigns available to the affiliate receiving the email. This allows you to:

• List all campaigns an affiliate is enrolled in
• Show campaign-specific information in welcome emails
• Create dynamic content based on campaign participation
• Generate personalized performance summaries

Usage in Templates

When creating email templates, you can iterate through the campaigns array to display campaign information:

{foreach from=$affiliatecampaigns item=campaign}
    Campaign: {$campaign.name}
    Status: {$campaign.status}
{/foreach}

This is particularly useful for:

• New affiliate welcome emails listing available campaigns
• Performance summary emails
• Campaign update notifications
• Targeted promotional communications

Join our newsletter

Be the first to know about new features and product updates.

Email address

Subscribe

Custom Options in Trends Report Plugin

The Custom Options in Trends Report plugin enhances the Trends Report by replacing the default data types with more detailed, tier-specific metrics. This provides merchants with deeper insights into their affiliate program performance.

Available Data Types

After enabling this plugin, the Trends Report will display the following metrics:

Click Metrics:

• Clicks (total)
• Clicks - Repeated
• Clicks - Unique

Tier 1 Metrics:

• Tier 1 - Trial Subscription (per commission type)
• Tier 1 - Recurring Subscription (per commission type)
• Tier 1 - Sales
• Tier 1 - Commissions

Tier 2 Metrics:

• Tier 2 - Trial Subscription (per commission type)
• Tier 2 - Recurring Subscription (per commission type)
• Tier 2 - Sales
• Tier 2 - Commissions

Aggregate Metrics:

• Actions Count (total across all types)
• Grand Total Commissions

Benefits

This plugin is essential for affiliate programs that:

• Use multi-tier commission structures
• Need to distinguish between different types of actions
• Want to analyze performance by commission tier
• Track subscription-based products with trial periods

Requirements

This plugin requires the Action Commission plugin to be active, as it depends on action-based commission types for generating the tier-specific metrics.

Channels List in Templates Plugin

The Channels List in Templates plugin adds channel information to affiliate panel templates, enabling dynamic content based on an affiliate’s tracking channels.

Template Variable

The plugin provides the {$channels} variable to all affiliate panel templates. This variable contains an associative array where:

• Key: The channel code (identifier)
• Value: The channel name (display name)

Performance Considerations

To ensure optimal performance, the plugin limits the number of channels loaded to 100 per affiliate. This prevents performance issues for affiliates with a large number of tracking channels.

Use Cases

This variable is valuable for:

• Displaying channel selection dropdowns in custom templates
• Showing channel-specific statistics
• Creating channel-aware promotional materials
• Building custom affiliate panel widgets

Example Usage

{if $channels}
    <h3>Your Active Channels</h3>
    <ul>
    {foreach from=$channels key=code item=name}
        <li>{$name} (Code: {$code})</li>
    {/foreach}
    </ul>
{/if}

UI Customization Best Practices

When using display and UI customization plugins, consider the following best practices:

Planning Your Customizations

1. Document your changes: Keep track of which plugins are enabled and how they are configured
2. Test thoroughly: Preview changes in a test environment before applying to production
3. Consider affiliate experience: Ensure customizations enhance rather than complicate the affiliate experience

Security

1. Minimize exposed data: Only enable the Affiliate Info fields that are absolutely necessary
2. Review audit logs: Regularly check campaign visibility changes in the Hide Campaigns plugin
3. Restrict sensitive information: Be cautious about exposing email addresses or other personal data

Performance

1. Monitor template rendering: Complex template variables can impact page load times
2. Use caching when possible: Consider caching strategies for pages using the Affiliate Info plugin
3. Limit channel counts: If affiliates have many channels, be aware of the 100-channel limit in templates

Plugin Dependencies and Requirements

Enabling Plugins

To enable any of these display and UI customization plugins:

1. Log in to the merchant panel
2. Navigate to Configuration > Plugins
3. Locate the desired plugin in the list
4. Click the Activate button
5. Configure the plugin settings as needed
6. Some plugins may require a system restart to take effect

All plugins can be enabled or disabled at any time without affecting your existing data or configurations.