CODEX
Shortcodes, Hooks & Functions
Complete reference for FOX – WooCommerce Currency Switcher
- SC [[woocs]] The main currency switcher shortcode: puts the drop-down, flags or link list on any page, widget or template. Attributes control the view, the styling and which currencies appear. →
- SC [[woocs_converter]] Adds a WooCommerce currency converter to any page — a small AJAX calculator that converts an amount between two currencies without touching your product prices. Attributes: exclude, precision. →
- SC [[woocs_geo_hello]] Diagnostic shortcode for Geo IP. Drop it on a page or in a widget to see whether geolocation is working, which country was detected and which currency the rules resolved to. →
- SC [[woocs_get_sign_rate]] Prints the current exchange rate of one currency against the shop base currency as plain text, anywhere in your content. →
- SC [[woocs_price]] Displays the price of a single product by its ID, in the currency the visitor selected — for landing pages and texts written outside the WooCommerce loop. →
- SC [[woocs_rates]] Shows your shop exchange rates to customers as a table. Attributes let you exclude currencies and change the layout. →
- SC [[woocs_show_current_currency]] Prints the currency the visitor is currently browsing in, with optional text before and after it. →
- SC [[woocs_show_custom_price]] Makes any amount in your promotional text switchable. Write the value in the base currency and it follows whichever currency the visitor picks. →
- do_action woocs_before_settings_update Action fired in wp-admin right after the nonce check and just before FOX writes its options from the submitted form. Use it to save extra fields added to the plugin settings page. →
- do_action woocs_exchange_value Entry point into the plugin: pass any amount in the base currency through this action and get it back in the currency the visitor selected. The everyday way to make your own numbers switchable. →
- do_action woocs_force_pay_bygeoip_rules Fires on the checkout page when "Checkout by GeoIP rules" is on, so you can override which currency the order is forced into for a given country. →
- do_action woocs_freemius_loaded Action fired once the Freemius SDK has been initialised, the safe point at which the licensing API is available. →
- do_action woocs_sheduler_rates_updated Fires after the scheduled exchange rate update finishes. Use it to log rate history, notify an external system or recalculate something that depends on the new rates. From v.2.4.5 / 1.4.5. →
- do_action woocs_update_rates_wpcron The scheduled event FOX attaches its rate refresh to. Firing it runs a full exchange rate update immediately, which is how to drive updates from a real server cron instead of WordPress cron. →
- apply_filters woocs_add_aggregator_processor Registers the code that fetches rates from your own exchange rate source. Works in pair with woocs_announce_aggregator. From v.2.3.1 / 1.3.1. →
- apply_filters woocs_add_custom_rate Changes a currency rate on the fly, or replaces rate fetching entirely with your own logic. From v.2.3.1 / 1.3.1. →
- apply_filters woocs_announce_aggregator Adds your own aggregator to the list the shop owner can choose from in the settings. Works in pair with woocs_add_aggregator_processor. From v.2.3.1 / 1.3.1. →
- apply_filters woocs_back_convert_price Entry point into the plugin: converts an amount from the currently selected currency back into the shop base currency. The fix for third-party rules that compare converted totals against base-currency thresholds. →
- apply_filters woocs_bank_polski_table Selects which rate table of the Narodowy Bank Polski aggregator to read. Default is table A. From v.2.3.1 / 1.3.1. →
- apply_filters woocs_capability_allows_change_order Lets chosen users edit order currency data without granting them the full manage_options capability. →
- apply_filters woocs_convert_price Entry point into the plugin: converts an amount from the base currency into the currently selected one. The standard way for a third-party plugin to become currency aware without a hard dependency on FOX. →
- apply_filters woocs_convert_price_wcdp Entry point into the plugin for discount engines: converts an amount from the base currency into the current one, but only when the third argument is discount__amount. →
- apply_filters woocs_cookie Filter changing the name of the FOX session cookie. Renaming it stops caches that treat any wp_-prefixed cookie as a logged-in user from bypassing the cache. Must be registered from mu-plugins. →
- apply_filters woocs_currency_data_manipulation Filters the whole currency table before the plugin uses it — rates, symbols, decimals and positions — so currency data can come from anywhere you like. →
- apply_filters woocs_currency_manipulation_before_show Filters the currency list just before the switcher is drawn, so you can hide, reorder or relabel currencies per page, per user or per any rule. →
- apply_filters woocs_currency_symbol_on_order Filter that tells FOX to leave the currency symbol untouched on the order-received and account pages, so a receipt keeps the symbol of the currency the order was paid in. Default false. →
- apply_filters woocs_currency_symbols Adds or replaces currency symbols. The hook to use for a custom currency symbol in WooCommerce, or for a currency that has no standard glyph at all. →
- apply_filters woocs_currname_in_option Changes the text of a currency line inside the switcher drop-down, when the default code plus symbol is not what your customers should read. →
- apply_filters woocs_cut_cart_price_format Drops the custom price format on the cart and checkout pages, where a decorated format sometimes fights with other plugins. →
- apply_filters woocs_disable_backend_refund_calculation Turns off currency conversion while a refund is processed in wp-admin, for shops that store refunds in the base currency by policy. →
- apply_filters woocs_drop_down_view Switches the currency switcher drop-down skin on the fly, so different pages or user groups can get different switcher designs. →
- apply_filters woocs_fixed_price_user_rope Filter passing the price resolved by the prices-based-on-user-role feature, along with the product ID, the price type and the user roles. Note the typo in the hook name: rope, not role. →
- apply_filters woocs_fixed_raw_woocommerce_price Filters the raw price when fixed per-currency prices are in play. The usual attachment point for making a third-party pricing plugin respect fixed prices. →
- apply_filters woocs_form_method Changes the switcher form method from POST to GET, which some caching setups and page builders need. From v.2.2.0 / 1.2.0. →
- apply_filters woocs_geobone_ip Filter controlling the first-visit-only behaviour of the Geo IP rules. Returning false disables the flag that makes a geo rule apply once per visitor. Default true. →
- apply_filters woocs_get_approximate_amount_text Changes the wording around the approximate amount shown on the cart and checkout pages when the "Show approx. amount" option is on. →
- apply_filters woocs_init_compatibility_woo_subscriptions Switches on compatibility with WooCommerce Subscriptions, so renewal amounts keep the currency the subscription was created in. →
- apply_filters woocs_order_formatted_prices Controls price formatting on the order and thank-you pages. Return false to leave WooCommerce formatting alone entirely. →
- apply_filters woocs_precision_on_calc Raises the internal calculation precision. Needed when unit prices are very small — at four decimals a 0.000423 item rounds to nothing. →
- apply_filters woocs_price_decimal_sep Sets the decimal separator per currency or per any other rule, so each market reads prices the way it expects. →
- apply_filters woocs_price_format Filters the whole WooCommerce price format string, for full control over where the symbol sits and what surrounds the number. →
- apply_filters woocs_price_html Filters the finished price markup of a product. The hook for adding a custom currency symbol, a note or any markup of your own to every price on the shop. →
- apply_filters woocs_price_html_tail Appends text or markup after a product price on shop and category pages — an approximate amount, a tax note, a per-unit hint. →
- apply_filters woocs_price_shortcode Filters the price produced by the [woocs_price] shortcode, so a price printed outside the product loop can follow its own rule. →
- apply_filters woocs_price_thousand_sep Sets the thousand separator per currency or per any other rule, so 1,299.00 and 1 299,00 can live on the same shop. →
- apply_filters woocs_product_fixed_price_data_simple_types Declares which product types fixed per-currency prices apply to, so a custom product type can join in. →
- apply_filters woocs_raw_woocommerce_price Filters the raw numeric price before formatting. This is where price rounding rules live — to 50 cents, to 99 cents, to a whole unit. →
- apply_filters woocs_redraw_cart Disables mini-cart redrawing after a currency switch, which resolves conflicts with themes and scripts that rebuild the cart themselves. →
- apply_filters woocs_show_side_swither Filter with the final say on whether the floating side switcher is rendered on the current page, applied after the plugin's own settings and exclusions. Note the typo in the hook name: swither. →
- apply_filters woocs_side_switcher_data Filter passing the whole configuration array of the side switcher — skin, side, offset, colours and field templates — before the panel is rendered. →
- apply_filters woocs_woocommerce_available_variation Filter passing the data array of a single variation after FOX converted its prices, including price_html, on its way to the front end as JSON. →
- apply_filters woocs_woocommerce_variation_prices Filters the price range of a variable product, so the from-to line on a variable product follows your own currency logic. →
- fn() $WOOCS->back_convert() Converts an amount from the currently selected currency back into the shop base currency — the fix for third-party code that compares a converted total against a base-currency threshold. →
- fn() $WOOCS->convert_from_to_currency($value, $from_currency, $to_currency) Converts an amount between any two currencies directly, without going through the base currency. Available from v.2.4.0 / v.1.4.0. →
- fn() $WOOCS->current_currency The property holding the currency the visitor is browsing in right now. The starting point for almost any custom currency logic. →
- fn() $WOOCS->default_currency The property holding the shop base currency, the one WooCommerce itself is configured with and the one every rate is calculated against. →
- fn() $WOOCS->get_checkout_page_id() Returns the ID of the checkout page, so your own code can tell reliably whether the current request is the checkout. →
- fn() $WOOCS->get_currencies($suppress_filters = false) Returns every currency configured in the plugin settings, with its rate, symbol, decimals and position — the whole currency table as an array. →
- fn() $WOOCS->get_currency_by_country() Returns the currency the Geo IP rules resolve for the visitor country. Works only while the Geo IP option is enabled. →
- fn() $WOOCS->get_currency_price_num_decimals() Returns how many decimals a given currency is configured to show, so your own price output matches the rest of the shop. →
- fn() $WOOCS->get_geo_rules() Returns the Geo IP rules array — which country maps to which currency — for reading or acting on from your own code. →
- fn() $WOOCS->get_welcome_currency() Returns the welcome currency: the one a first-time visitor sees before making any choice of their own. →
- fn() $WOOCS->is_multiple_allowed The property that tells you whether multi currency checkout is enabled, that is, whether customers may pay in the currency they selected. →
- fn() $WOOCS->is_use_geo_rules() Returns true when the Geo IP option is enabled, so your code can branch on whether country rules are in play at all. →
- fn() $WOOCS->make_rates_auto_update() Runs a full exchange rate update immediately, the same one the built-in cron performs. Use it to drive updates from a real server cron. →
- fn() $WOOCS->reset_currency() Resets the visitor back to the shop base currency — useful when a third-party process must run in base-currency context. →
- fn() $WOOCS->set_currency() Sets the currency for the current visitor from your own code, whatever logic you need. Available from v.2.1.8 / v.1.1.8. →
- fn() $WOOCS->storage->get_val() Reads a value from the FOX storage layer — the selected currency among others — whichever storage backend the shop is configured with. →
- fn() $WOOCS->storage->set_val() Writes a value into the FOX storage layer, so custom code can persist state alongside the plugin instead of inventing its own session. →
- fn() $WOOCS->woocs_exchange_value() Converts an amount from the shop base currency into the currency the visitor selected — the everyday conversion call. →
- fn() REST API REST API endpoints for reading currency data and product prices programmatically, for headless front ends, mobile apps and external integrations. →