Developer Documentation

Introduction

This page is for developers who want to adjust or extend Tiered Pricing Table for WooCommerce with code: read and change prices, override templates, hook into the JavaScript, use the REST API, and — most importantly — the complete list of actions and filters. Store-owner documentation lives in the User Guide.

Prices and rules

Read the effective rule and price

use TierPricingTable\PriceManager;

$rule = PriceManager::getPricingRule( $product_id );   // TierPricingTable\PricingRule — product meta + role/customer/global rules applied

$rule->getRules();            // [ 5 => 9.5, 10 => 8.0 ] (fixed) or [ 5 => 10, 10 => 20 ] (percentage)
$rule->getType();             // 'fixed' | 'percentage'
$rule->getMinimum();          // ?int
$rule->provider;              // 'product' | 'role-based' | 'user-based' | 'global-rules' | …
$rule->providerData;          // e.g. [ 'rule_id' => 42, 'applying_type' => 'cross' ] or [ 'role' => 'wholesale' ]
$rule->data;                  // 'maximum_quantity', 'group_of_quantity', 'tier_labels', …
$rule->pricingData;           // base-price overrides: regular_price, sale_price, discount, discount_type, pricing_type, tax_status, tax_class

$unit = $rule->getTierPrice( 12 );                 // display price for qty 12 (false if below the first tier)
$unit = $rule->getTierPrice( 12, false, 'cart' );  // raw price, cart context

$has = ! empty( $rule->getRules() );
$has = \TierPricingTable\PricingTable::getInstance()->productHasPricingRules( $product ); // variable products too

Change the rule for any product

tiered_pricing_table/price/pricing_rule receives the PricingRule after product meta was read. Built-in providers use these priorities — pick yours relative to them: quantity limits 1, category rules 10, role-based 20, customer-based 25, global rules 30, request-a-quote 99, currency conversion 9999.

add_filter( 'tiered_pricing_table/price/pricing_rule', function ( \TierPricingTable\PricingRule $rule, int $productId ) {
    if ( has_term( 'clearance', 'product_cat', $productId ) ) {
        $rule->setType( 'percentage' );
        $rule->setRules( [ 3 => 15, 6 => 25 ] );      // 15 % off from 3 units, 25 % from 6
        $rule->logPricingModification( 'Clearance tiers applied by my-plugin' ); // shown in Debug mode
    }
    return $rule;
}, 40, 2 );

Other useful filters: …/price/price_by_rules (final unit price for a quantity), …/price/round_price / …/price/round_precision, …/cart/product_cart_price (price set on a cart item), …/cart/total_product_count (quantity used to pick the tier in the cart), …/cart/need_price_recalculation (skip an item), …/services/regular_pricing/price (adjusted regular/sale price for the current user), …/global_pricing/matched_pricing_rule (which global rule applies).

Write rules programmatically

// Product-level
update_post_meta( 123, '_fixed_price_rules', [ 5 => '9.50', 10 => '8.00' ] );
update_post_meta( 123, '_tiered_price_rules_type', 'fixed' );
\TierPricingTable\PriceManager::updateProductMinimumQuantity( 123, 5 );

// Role-based
\TierPricingTable\Addons\RoleBasedPricing\RoleBasedPricingRule::buildFromArray( 123, 'wholesale', [
    'pricing_type' => 'flat', 'regular_price' => 20, 'sale_price' => 18,
    'tiered_pricing_type' => 'fixed', 'fixed_tiered_pricing_rules' => [ 10 => 17, 50 => 15 ],
    'minimum_order_quantity' => 5,
] )->save();

// Global rule (post type tpt-global-rule)
use TierPricingTable\Addons\GlobalTieredPricing\CPT\GlobalTieredPricingCPT;
use TierPricingTable\Addons\GlobalTieredPricing\GlobalPricingRule;

$ruleId = wp_insert_post( [ 'post_type' => GlobalTieredPricingCPT::SLUG, 'post_status' => 'publish', 'post_title' => 'Wholesale tiers' ] );
$rule   = GlobalPricingRule::fromArray( [ 'tiered_pricing_type' => 'fixed', 'fixed_rules' => [ 10 => 9.5, 50 => 8 ], 'minimum' => 5, 'applying_type' => 'individual' ] );
$rule->setId( $ruleId );
$rule->setIncludedProductCategories( [ 15 ] );
$rule->setIncludedUsersRole( [ 'wholesale' ] );
$rule->save();

\TierPricingTable\Core\ServiceContainer::getInstance()->getCache()->purge();

Templates

Render the table yourself

ob_start();
\TierPricingTable\PricingTable::getInstance()->renderPricingTable( $product_id, null, [ 'display' => true, 'display_type' => 'blocks', 'title' => 'Volume pricing' ] );
$html = ob_get_clean();

Settings keys you can pass: display_type (table, blocks, options, dropdown, horizontal-table, plain-text, tooltip), title, quantity_column_title, price_column_title, discount_column_title, quantity_type (range \| static), show_discount_column, clickable_rows, active_tier_color, table_style, blocks_style, options_style, compact_layout, options_show_total, options_show_original_product_price, options_show_default_option, options_option_text, plain_text_option_text, update_price_on_product_page, show_total_price, quantity_measurement_singular, quantity_measurement_plural. The same keys work as shortcode attributes. Use tiered_pricing_table/should_render_pricing_table to suppress the automatic output and tiered_pricing_table/display_settings to change settings on the fly.

Override templates from a theme

Copy any file from the plugin’s views/frontend/ folder (tiered-pricing-table.php, tiered-pricing-blocks-style-3.php, summary-table.php, …) to **wp-content/themes/{your-theme}/tiered-pricing-table/** and edit it there. tiered_pricing_table/template/location lets a plugin redirect a template.

Variables in layout templates: $pricing_rule (PricingRule), $price_rules, $pricing_type, $minimum, $product, $product_id, $settings, $id.

Inject content into layouts

// Extra column in the table layouts
add_action( 'tiered_pricing_table/tiered_pricing/header_columns', fn() => print '<th>Total</th>' );
add_action( 'tiered_pricing_table/tiered_pricing/row_columns', function ( \TierPricingTable\PricingRule $rule, $qty ) {
    $qty   = $qty ?: max( 1, (int) $rule->getMinimum() ); // null = base row
    $price = $rule->getTierPrice( $qty );
    echo '<td>' . ( $price ? wc_price( $price * $qty ) : '—' ) . '</td>';
}, 10, 2 );

// Badge next to a tier in every layout
foreach ( [ 'table', 'horizontal-table', 'blocks', 'options', 'dropdown', 'plain-text' ] as $layout ) {
    add_action( "tiered_pricing_table/{$layout}/label", function ( $rule, $qty ) {
        if ( 50 === (int) $qty ) { echo '<span class="my-badge">Best value</span>'; }
    }, 10, 2 );
}

// "100 or more" instead of "100+"
add_filter( 'tiered_pricing_table/tiered_pricing/last_tier_postfix', fn() => ' or more' );

All layout hooks are listed under Template hooks.

JavaScript

The frontend engine (tiered-pricing-table-front-js, jQuery) exposes document.__tieredPricing:

// Point the plugin at a custom quantity input / price container
document.__tieredPricing = document.__tieredPricing || { overrides: {} };
document.__tieredPricing.overrides.$getQuantityField  = ( parentId ) => jQuery( '#my-qty-' + parentId );
document.__tieredPricing.overrides.$getPriceContainer = ( productId, parentId ) => jQuery( '#my-price-' + parentId );

// React to quantity changes
jQuery( document ).on( 'tiered_price_update', '.tpt__tiered-pricing', function ( event, data ) {
    // data.quantity, data.price, data.price_excl_tax, data.productId, data.parentId,
    // data.pricing = { price, price_excl_tax, price_incl_tax, priceHtml, tieredQuantity, eventQuantity }
} );

// Set the quantity
jQuery( '.quantity-input-product-123' ).val( 10 ).trigger( 'change' );

// Initialise tables inserted after page load (quick view, AJAX)
document.querySelectorAll( '.tpt__tiered-pricing' ).forEach( function ( el ) {
    if ( ! el.__tptInit ) { el.__tptInit = true; document.__tieredPricing.initFunction( el ); }
} );

The live product price is WooCommerce’s price HTML wrapped in <span class="tiered-pricing-dynamic-price-wrapper" data-price-type="dynamic|static|no-rules">; return static from tiered_pricing_table/frontend/default_price_behaviour_type to keep WooCommerce’s price, or false from …/frontend/wrap_price to skip the wrapper. Styling hooks: .tpt__tiered-pricing, .tiered-pricing--active, .tiered-pricing-table, .tiered-pricing-block, .tiered-pricing-option, .tiered-pricing-dropdown, .tier-pricing-summary-table, .tiered-pricing-you-save, .tiered-pricing-tier-label.

Shortcodes, block & widget

REST API

The WooCommerce product and variation endpoints (/wp-json/wc/v3/products/{id}, /products/{id}/variations/{vid}) read and write these fields:

PUT /wp-json/wc/v3/products/123
{
  "tiered_pricing_type": "percentage",
  "tiered_pricing_percentage_rules": { "10": 5, "50": 12.5 },
  "tiered_pricing_minimum_quantity": 5,
  "tiered_pricing_roles_data": { "wholesale": { "pricing_type": "percentage", "discount": 15, "tiered_pricing_type": "fixed", "fixed_tiered_pricing_rules": { "10": 7.5 }, "minimum_order_quantity": 4 } }
}

Add your own field by extending TierPricingTable\Services\API\ProductFields\ProductField and appending the class with tiered_pricing_table/api/product_fields. Plugin routes: tier-pricing-table/v1/quote-request (POST, public), /quote-forms, /quote-settings, /tax-settings, tier-pricing-table/features/tier-labels/v1/labels, …/custom-columns/v1/columns, …/tools/v1/*. WooCommerce CSV import/export columns: tiered_price_fixed, tiered_price_percentage (qty:value,…), tiered_price_type, tiered_price_minimum and per-role {role}_tiered_price_*.

Extending the admin

// A setting in the General tab (option tier_pricing_table_my_hide_for_guests, 'yes' | 'no')
add_filter( 'tiered_pricing_table/settings/general_settings', function ( array $fields ) {
    $fields[] = [
        'title'   => 'Hide table for guests',
        'id'      => \TierPricingTable\Settings\Settings::SETTINGS_PREFIX . 'my_hide_for_guests',
        'type'    => \TierPricingTable\Settings\CustomOptions\TPTSwitchOption::FIELD_TYPE,
        'default' => 'no',
    ];
    return $fields;
} );

// An integration with its own on/off toggle under Settings → Integrations (boot-time filter)
class My_Integration extends \TierPricingTable\Integrations\Plugins\PluginIntegrationAbstract {
    public function getTitle(): string       { return 'My Plugin'; }
    public function getDescription(): string { return 'Adds option costs to tiered prices.'; }
    public function getSlug(): string        { return 'my-plugin'; }
    public function run() { add_filter( 'tiered_pricing_table/cart/product_cart_price', [ $this, 'addOptionsCost' ], 20, 2 ); }
}
add_filter( 'tiered_pricing_table/integrations/plugins', fn( array $list ) => array_merge( $list, [ My_Integration::class ] ) );

• Settings tabs and fields: tiered_pricing_table/settings/sections, …/general_settings, …/general_subsections, …/calculation_logic, …/advanced_settings. Field types: tpt_switch_option, tpt_display_type, tpt_text_template, tpt_link_button.
• Product editor: render fields on tiered_pricing_table/admin/pricing_tab_begin|after_minimum_order_quantity_field|advance_product_options|pricing_tab_end ($postId) and inside the rules form (…/admin/tiered_pricing_rules_form/form_begin|inputs|form_end); save on woocommerce_process_product_meta / woocommerce_save_product_variation. Name fields with TierPricingTable\Forms\Form::getFieldName( $base, $role, $loop ).
• Role / customer rules: render on …/admin/role_based_rules/after_tiered_pricing_rules_field (and user_based_rules), save on …/role_based_rules/save_role_based_rules (and user_based_rules/save_user_based_rules).
• Global rules: add a tab with tiered_pricing_table/global_pricing/form_tabs (extend CPT\Form\FormTab), save in …/global_pricing/before_updating, read your meta in …/global_pricing/after_built_rule, add list columns with …/global_pricing/columns.
• Custom table columns: extend Addons\CustomColumns\Columns\AbstractCustomColumn and register it with tiered_pricing_table/custom_columns/available_columns_types + …/custom_columns/columns_handlers.
• Addons: extend Addons\AbstractAddon and add it with tiered_pricing_table/addons/list (boot-time filter); it gets a toggle on the Modules tab.

Debugging

• Debug mode (Settings → Modules → Debug) prints the resolved rule under each cart item and inside the pricing table, including the log written with PricingRule::logPricingModification().
• Cache: catalog price HTML is cached in the tpt_product_data transient — purge from Settings → Modules → Cache or with ServiceContainer::getInstance()->getCache()->purge().
• $GLOBALS['tpt_current_user_id'] makes every price calculation run for that user (manual orders use it).

Hooks reference

Every filter and action fired by the plugin, grouped by topic. Type is F (filter — return the first parameter) or A (action). Parameters are listed in order; the first parameter of a filter is the value to return. Every row is deep-linkable (the row id is hook- + the hook name with non-alphanumerics replaced by -). All names are prefixed with tiered_pricing_table/ unless shown in full.

Bootstrap & services

Price calculation

Cart & checkout

Product page, dynamic price & catalog

Template hooks

Fired inside the layout templates in views/frontend/. $args for label actions is ['id' => $id, 'style' => '<style>']; $qty is null for the base (minimum) row in row_columns.

Tier labels & custom columns

Global pricing rules

Role-based pricing

Customer-based pricing

Admin product editor

REST API, import & export

Integrations

Settings

Resources

• User Guide — store-owner documentation for every feature.
• Guides — how-to articles.
• Contact us — missing hook or integration question? Let us know.