User Guide | Currency

Currencies can be setup to display item and cart pricing in a customers currency of choice.

Below is a compiled list of functions related to the carts currency data.

Currency User Guide Index

Currency Config | Get Currency Session Data | Get Currency Helper Data | Set Currency Session Data | Currency Admin Data

Currency Configuration

Customise the configuration of the carts default currency settings and curreny database table via the config file.

Currency Config. File Settings

Getting Data

Get data from the carts session or database.
Currency Data
  • currency_name()
    Returns the name of the carts current currency.
  • currency_symbol()
    Returns the symbol of the carts current currency.
  • exchange_rate()
    Returns the exchange rate of the carts current currency compared to the carts internal currency.

Database / Helper Data
  • format_currency()
    Returns a submitted value as a formatted currency.
  • get_currency_data()
    SQL SELECT query on currency table.
  • get_currency_symbol()
    Returns the symbol of the specific currency, using the database.
  • get_exchange_rate()
    Returns the exchange rate of a specific currency in comparison to the sites internal currency, using the database.
  • get_currency_value()
    Returns a value converted from one currency to the carts internal currency or vice versa, ignoring whether values include tax.
  • get_taxed_currency_value()
    Returns a value converted from one currency to the carts internal currency or vice versa, adjusting values for differences in tax.

Setting Data

Set data to the carts session data.
Currency Data
  • update_currency()
    Updates the carts currency that prices are displayed in, using the database.
  • set_currency()
    Updates the carts currency that prices are displayed in, using manually submitted values.

Admin Data

Run database management functions.
Currency Table CRUD Functions