Filter Action List – Advanced Customization and Integration

Developer Documentation #

For advanced customization and integration, the Points and Rewards plugin provides full support for template overrides, hooks, and filters. This section is intended for developers who want to extend or modify plugin behavior beyond the standard settings available in the admin dashboard.

Use the tools below to:

• Override frontend templates to match your theme
• Hook into plugin actions (e.g. points updates, expirations)
• Filter dynamic content like templates, arguments, or notification timings

Whether you’re building a custom theme integration or automating loyalty workflows, this guide will help you tap into the full power of the plugin.

---

Template Overrides

You can override any template by copying it to your theme directory. The plugin will look for templates in the following order:

1. your-theme/wpgens-loyalty/template-name.php
2. your-theme/template-name.php
3. plugin/templates/template-name.php

Available templates to override:

• points-page.php – Main points and rewards page
• points-earn.php – Points earning section
• points-redeem.php – Points redemption section
• points-rewards.php – Rewards history section
• points-stats.php – Points statistics section

Available Filters

• wpgens_loyalty_locate_template – Filter template path before loading
• wpgens_loyalty_get_template – Filter template file before including
• wpgens_loyalty_template_args – Filter template arguments
• wpgens_loyalty_expiry_warning_days – Filter number of days before points expire to send warning
• wpgens_loyalty_is_using_cart_checkout_block – Filter to determine if using cart/checkout blocks

Available Actions

• wpgens_loyalty_activate – Fires when plugin is activated
• wpgens_loyalty_deactivate – Fires when plugin is deactivated
• wpgens_loyalty_points_updated – Fires when points are updated
  • Parameters: $user_id, $new_balance, $points_delta, $type, $source
• wpgens_loyalty_points_expired – Fires when points expire
  • Parameters: $user_id, $current_balance, $expiration_period
• wpgens_loyalty_update_points – Fires whenever points are added or deducted
  • Parameters: $user_id, $points, $type, $source, $reference_id, $description
  • $type: ‘add’ or ‘deduct’
  • $source: Source of points (e.g. ‘purchase’, ‘review’, ‘referral’, ‘manual’)
  • $reference_id: Optional reference ID (e.g. order ID, product ID)
  • $description: Description of the points transaction
• wpgens_loyalty_daily_cron – Fires on daily cron job
• wpgens_loyalty_twice_daily_cron – Fires on twice daily cron job

Example Usage #

// Add custom points earning action
add_action('wpgens_loyalty_points_updated', function($user_id, $new_balance, $points_delta, $type, $source) {
    if ($source === 'custom_action') {
        // Do something when points are updated
    }
});

// Modify template arguments
add_filter('wpgens_loyalty_template_args', function($args, $template_name) {
    if ($template_name === 'points-page.php') {
        $args['custom_data'] = 'value';
    }
    return $args;
});

// Override expiry warning period
add_filter('wpgens_loyalty_expiry_warning_days', function($days) {
    return 14; // Send warning 14 days before expiry
});