WCML Hooks Reference

Modify strings used in the Set prices in other currencies manually section.

add_filter( 'wcml_custom_prices_strings', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$strings

(array) The string array used in the custom price section. It looks like the following:

array(
'not_set' => sprintf( __( 'Multi-currency is enabled but no secondary currencies have been set. %sAdd secondary currencies%s.',
'woocommerce-multilingual' ), '', '' ),
'calc_auto' => __( 'Calculate prices in other currencies automatically', 'woocommerce-multilingual' ),
'see_prices' => __( 'Click to see the prices in the other currencies as they are currently shown on the front end.', 'woocommerce-multilingual' ),
'show' => __( 'Show', 'woocommerce-multilingual' ),
'hide' => __( 'Hide', 'woocommerce-multilingual' ),
'set_manually' => __( 'Set prices in other currencies manually', 'woocommerce-multilingual' ),
'enter_prices' => __( 'Enter prices in other currencies', 'woocommerce-multilingual' ),
'hide_prices' => __( 'Hide prices in other currencies', 'woocommerce-multilingual' ),
'det_auto' => __( 'Determined automatically based on exchange rate', 'woocommerce-multilingual' ),
'_regular_price' => __( 'Regular Price', 'woocommerce-multilingual' ),
'_sale_price' => __( 'Sale Price', 'woocommerce-multilingual' ),
'schedule' => __( 'Schedule', 'woocommerce-multilingual' ),
'same_as_def' => __( 'Same as default currency', 'woocommerce-multilingual' ),
'set_dates' => __( 'Set dates', 'woocommerce-multilingual' ),
'collapse' => __( 'Collapse', 'woocommerce-multilingual' ),
'from' => __( 'From…', 'woocommerce-multilingual' ),
'to' => __( 'To…', 'woocommerce-multilingual' ),
'enter_price' => __( 'Please enter in a value less than the regular price', 'woocommerce-multilingual' )
)


$product_id

(integer) The ID of an original product.

This filter adds ?wcmlc={currency_code} to the URL, which specifies a query string with the currency code. This is useful when your site has cache enabled and doesn’t show currency changes correctly.

add_filter( 'wcml_is_cache_enabled_for_switching_currency', 'the_callback_function', 10, 1 );

There is only one parameter passed to this filter:

$enabled

(bool) Set to true to enable the filter.

Allow the overriding of the WCML geolocated country.

$userCountry

(string) Billing address used if set otherwise geolocation country.

$allUserCountries

(array) {

@key $billing

(string) The billing address country

@key $shipping

(string) The shipping address country

@key $geolocation

(string) The geolocation country

}

Allows overriding the storage strategy. The default storage is wc-session, and the only current alternative is cookie.

‘wc-session’

(string) Storage strategy

$key

(string) The key operating the storage

// Use Cookie instead of WCSession
add_filter( 'wcml_user_store_strategy', function ( $strategy, $key ) {
	return 'cookie';
}, 10, 2 );

• Filter second currency prices after applying rounding rules.
• These rules are set on the WooCommerce -> WooCommerce Multilingual page, under the Multi-currency tab.

add_filter( 'wcml_rounded_price', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$price

(integer) The price after applying rounding rules.

$currency

(string) The second currency code, e.g. “USD”, “EUR”, etc.

• Filter the array of currencies without cents.
• By default, this array includes the following currencies:
  array('JPY', 'TWD', 'KRW', 'BIF', 'BYR', 'CLP', 'GNF', 'ISK', 'KMF', 'PYG', 'RWF', 'VUV', 'XAF', 'XOF', 'XPF');

add_filter( 'wcml_currencies_without_cents', 'the_callback_function' );

There is only one parameter passed to this filter: currencies.

$currencies

(array) The array of currencies without cents.

Filter custom prices set for products.

add_filter( 'wcml_product_custom_prices', 'the_callback_function', 10, 3 );

There are three parameters passed to this filter:

$custom_prices

(array) The custom price array. Their keys include:

'_price', '_regular_price', '_sale_price',
'_min_variation_price',
'_max_variation_price',
'_min_variation_regular_price', '_max_variation_regular_price',
'_min_variation_sale_price',
'_max_variation_sale_price'

$product_id

(integer) The product ID.

$currency

(string) The second currency whose custom prices are being saved, e.g. “USD”, “EUR”, etc.

Run your custom functions right after the client currency for the front end is switched via AJAX requests.

add_action( 'wcml_switch_currency', 'the_callback_function', 10, 1 );

There is one parameter being passed to this action: new_currency.

$new_currency

(string) The new currency code is switched to, e.g. “USD”, “EUR”, etc.

• Add custom price field labels to products.
• These fields are displayed in the Set prices in other currencies manually section when editing/creating original products.
• To add custom price fields, see the wcml_custom_prices_fields hook.

add_filter( 'wcml_custom_prices_fields_labels', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$labels

(array) The custom price field label array.

$product_id

(integer) The ID of an original product.

Use the example code provided below to get results shown in the following screenshot.

/*
 * Add this code to the functions.php file of your theme.
 */
add_filter( 'wcml_custom_prices_fields',  'add_custom_price_fields', 10, 2 );
function add_custom_price_fields( $fields, $product_id ) {
    
    // Add a new custom price field 
    $fields[] = '_sign_up_fee'; 

    return $fields;

}


add_filter( 'wcml_custom_prices_fields_labels', 'set_labels_for_price_fields', 10, 2 );
function set_labels_for_price_fields( $labels, $product_id ){

    // Edit the label of a custom price field
    $labels[ '_sign_up_fee' ] = __( 'Sign-up Fee', 'woocommerce-multilingual' ); 

    return $labels;

}

• Add additional custom price fields to products.
• These fields are displayed in the Set prices in other currencies manually section when editing/creating original products.
• To add custom price field labels, see the wcml_custom_prices_fields_labels hook.

add_filter( 'wcml_custom_prices_fields', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$fields

(array) The custom price field array.

$product_id

(integer) The ID of an original product.

Use the example code provided below to get results shown in the following screenshot.

/*
 * Add this code to the functions.php file of your theme.
 */
add_filter( 'wcml_custom_prices_fields',  'add_custom_price_fields', 10, 2 );
function add_custom_price_fields( $fields, $product_id ) {
    
    // Add a new custom price field 
    $fields[] = '_sign_up_fee'; 

    return $fields;

}


add_filter( 'wcml_custom_prices_fields_labels', 'set_labels_for_price_fields', 10, 2 );
function set_labels_for_price_fields( $labels, $product_id ){

    // Edit the label of a custom price field
    $labels[ '_sign_up_fee' ] = __( 'Sign-up Fee', 'woocommerce-multilingual' ); 

    return $labels;

}

Add or remove the AJAX actions that need our multi-currency filters.

add_filter( 'wcml_multi_currency_ajax_actions', 'the_callback_function', 10, 1 );

There is only one parameter passed to this filter: ajax_actions.

$ajax_actions

(array) The array including AJAX actions.

This is a filter used to define whether or not the multi-currency filters for AJAX actions are loaded.

add_filter( 'wcml_load_multi_currency_in_ajax', 'the_callback_function', 10, 1 );

There is only one parameter passed to this filter: load.

$load

(bool) The boolean value to define whether or not to load AJAX actions.

Filter the custom prices for the second currency before saving them.

add_filter( 'wcml_update_custom_prices_values', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$prices

(array) The custom price array looks like the following:

array(
'_regular_price' => $regular_price,
'_sale_price' => $sale_price,
'_wcml_schedule' => $schedule,
'_sale_price_dates_from' => $date_from,
'_sale_price_dates_to' => $date_to )

$currency

(string) The second currency whose custom prices are being saved, e.g. “USD”, “EUR”, etc.

Filter the currency set by the user on the front-end.

add_filter( 'wcml_client_currency', 'the_callback_function', 10, 1 );

There is only one parameter passed to this filter: currency.

$currency

(string) The code of the currency used on the front-end, e.g. “USD”, “EUR”, etc.

Filter the exchange rates used by WooCommerce Multilingual.

add_filter( 'wcml_exchange_rates', 'the_callback_function', 10, 1 );

There is only one parameter passed to this filter: exchange_rates.

$exchange_rates

(array) The array includes your site currencies’ rates against the default currency.

Convert a default currency price to the selected currency, using the correct format.

apply_filters( 'wcml_formatted_price', integer/float $price, string $currency )

$price

(integer/float) (Required) The raw price in the default currency.

$currency

(string) (Optional) The currency code you want to convert the price into, e.g. “USD”, “EUR”, etc. If this parameter is not set, the current currency used on the front-end will be used.

• Get the current currency set on the front-end.
• This filter is available on the front-end.

apply_filters( 'wcml_price_currency', mixed $empty_value )

$empty_value

(mixed) (Required) Normally, this is the value the filter will be modifying. We are not filtering anything here so you should set this to NULL. This argument allows the filter’s function to receive the full list of arguments.

Run your custom functions right after the client currency for the front-end is set.

add_action( 'wcml_set_client_currency', 'the_callback_function', 10, 1 );

There is one parameter being passed to this action: currency.

$currency

(string) The currency code is being set in the front-end, e.g: “USD”, “EUR”, etc.

• Run actions after generating the custom price block on the WooCommerce native product editor.
• This action is triggered when creating or editing the original products only.

add_action( 'wcml_after_custom_prices_block', 'the_callback_function', 10, 1 );

There is one parameter being passed to this action:

$product_id

(integer | string) The ID of editing product OR the string value new if the product is being created.

Run actions before generating the Multi-currency tab in the WPML -> Woocommerce Multilingual screen.

add_action( 'wcml_before_multi_currency_ui', 'the_callback_function' );

This action has no parameter.

• Run actions after saving custom prices on the WooCommerce native product editor.
• This action is triggered when creating or editing the original products only.

add_action( 'wcml_after_save_custom_prices', 'the_callback_function', 10, 1 );

There is one parameter being passed to this action:

$product_id

(integer) The ID of original product.

• Convert the raw price in the default currency into the selected currency.
• This filter should be used for filtering product/variations prices in general.
• It is available on the front-end.

This filter is applied to the custom fields of products and variations that are used for prices (when they are read from the database):

• _price
• _regular_price
• _sale_price
• _min_variation_price
• _min_variation_price_regular_price
• _mix_variation_price_sale_price
• _max_variation_price
• _max_variation_price_regular_price
• _max_variation_price_sale_price

apply_filters( 'wcml_raw_price_amount', integer/float $price, string $currency )

$price

(integer/float) (Required) The raw price in the default currency.

$currency

(string) (Optional) The currency code you want to convert the price into, e.g. “USD”, “EUR”, etc. If this parameter is not set, the current currency used on the front-end will be used.

Run actions when the currency switcher widget is being generated.

add_action( 'wcml_currency_switcher', 'the_callback_function' );

This action has no parameters.

• This hook returns the custom price if entered. Otherwise, it returns the price based on the set exchange rate.
• This hook works only on the front-end.

apply_filters( 'wcml_product_price_by_currency', integer $product_id, string $currency )

$product_id

(integer) (Required) The product ID

$currency

(string) (Required) The currency code you want to get the price for, e.g. “USD”, “EUR”, etc.

Add or remove custom fields in the WCML Translation Editor.

add_filter( 'wcml_product_content_fields', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$fields

(array) The custom field array.

$product_id

(integer) The ID of an original product.

Modify custom field names in the WCML Translation Editor.

add_filter( 'wcml_product_content_label', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$meta_key

(string) The custom field key.

$product_id

(integer) The ID of an original product.

Run actions after duplicating a product.

add_action( 'wcml_after_duplicate_product', 'the_callback_function', 10, 2 );

There are two parameters being passed to this action:

$new_id

(integer) The ID of new product.

$post_to_duplicate

(object) The original post data to duplicate.

Add filters to check if the current product page is an attribute page. This is useful for WooCommerce extensions that have their own attribute pages.

add_filter( 'wcml_is_attributes_page', 'the_callback_function' );

There is one parameter passed to this filter:

$is_attribute_page

(bool) Whether or not the current page is an attribute page.

Filter language for Gateway strings ( title, description, instructions )

$current_gateway_language

(string) Gateway string language

add_filter( 'wcml_current_gateway_language', 'use_current_language_for_gateway_strings' );

public function use_current_language_for_gateway_strings( $current_gateway_language ){
    return apply_filters( 'wpml_current_language' );
}

Use this filter to set the language of the email sent to the administrator when a new order is placed or the status of an existing one changes.

apply_filters( 'wcml_new_order_admin_email_language', $admin_language, $recipient, $order_id )

There are three parameters being passed to this filter:

$admin_language

(string) The admin user language.

$recipient

(string) The admin user email.

$order_id

(integer) The order ID.

• admin user language
• $recipient admin user email
• order id

Can be used for shipping methods translations.

apply_filters( 'wcml_translate_shipping_method_in_package', true, $key, $method )

There are two parameters being passed to this filter:

$key

The method key.

$method

The method object.

• Add additional fields to translate in WCML Translation Editor.
• To add translation data, see the wcml_gui_additional_box_data hook.

add_action( 'wcml_gui_additional_box_html', 'the_callback_function', 10, 3 );

There are three parameters being passed to this action:

$obj

(object) The translation job object.

$product_id

(integer) The ID of original product.

$data

(array) The translation job data array.

• Filter the IDs of variation’s taxonomies that a term belongs to.
• Some WooCommerce extensions add their own custom variation product post types like WooCommerce Subscriptions. This filter is used in the function to check whether or not a product is variable. It collects all variation’s taxonomy IDs a term belongs to, for variable products.

add_filter( 'wcml_variation_term_taxonomy_ids', 'the_callback_function' );

There is only one parameter passed to this filter: term_taxonomy_ids.

$term_taxonomy_ids

(array) The array containing taxonomy term IDs of variable product types.

Add filters to check if a product is variable. This is useful for WooCommerce extensions that have their own variable product types.

add_filter( 'wcml_is_variable_product', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$is_variable

(bool) Whether or not the product is variable.

$product_id

(integer) The product ID.

Add new WooCommerce endpoints to be ready for translation with WooCommerce Multilingual.

add_filter( 'wcml_register_endpoints_query_vars', 'the_callback_function', 10, 3 );

There are three parameters passed to this filter:

$query_vars

(array) The WordPress query var (endpoint) array.

$wc_vars

(array) The WooCommerce default endpoint array.

$obj

(object) The WCML_Endpoints object.

Run actions during WPML AJAX requests.

add_action( 'wcml_localize_woocommerce_on_ajax', 'the_callback_function' );

This action has no parameters.

Add or remove the custom fields that do not display in the WCML Translation Editor.

add_filter( 'wcml_not_display_single_fields_to_translate', 'the_callback_function', 10, 1 );

There is only one parameter passed to this filter: fields.

$fields

(array) The custom field array.

Add or remove the WooCommerce page option names used in WooCommerce Multilingual.

add_filter( 'wcml_wc_installed_pages', 'the_callback_function', 10, 1 );

There is only one parameter passed to this filter: page_option_names.

$page_option_names

(array) The page option name array looks like the following:

array(
'woocommerce_shop_page_id',
'woocommerce_cart_page_id',
'woocommerce_checkout_page_id',
'woocommerce_myaccount_page_id'
)

Run actions after loading the JavaScript code for locking fields on the translated product editor page (WooCommerce native editor).

add_action( 'wcml_after_load_lock_fields_js', 'the_callback_function' );

This action has no parameter.

• Add translation data for fields in custom sections of WCML Translation Editor.
• To add fields, see the wcml_gui_additional_box_html hook.

add_filter( 'wcml_gui_additional_box_data', 'the_callback_function', 10, 4 );

There are four parameters being passed to this filter:

$data

(array) The translation job data array.

$product_id

(integer) The ID of original product.

$translation

(object) The translation job object.

$target_language

(string) The language code of translated product.

Filter endpoint values before getting permalinks.

add_filter( 'wcml_endpoint_permalink_filter', 'the_callback_function', 10, 2 );

There are two parameters passed to this filter:

$endpoint

(string) The endpoint value.

$key

(string) The endpoint key.

Add or remove custom field input names that are locked on the WooCommerce native product editor of translated products.

add_filter( 'wcml_js_lock_fields_input_names', 'the_callback_function' );

There is only one parameter passed to this filter:

$names

(array) The array including custom field input names.

Add or remove custom field classes that are locked on the WooCommerce native product editor of translated products.

add_filter( 'wcml_js_lock_fields_classes', 'the_callback_function' );

There is only one parameter passed to this filter:

$classes

(array) The array including custom field classes.

Add or remove custom field IDs that are locked on the WooCommerce native product editor of translated products.

add_filter( 'wcml_js_lock_fields_ids', 'the_callback_function' );

There is only one parameter passed to this filter:

$ids

(array) The array including custom field IDs.

• Run actions before WCML syncs original products to their translated products.
• This action is called before wcml_before_sync_product_data.

add_action( 'wcml_before_sync_product', 'the_callback_function', 10, 2 );

There are two parameters being passed to this action:

$original_product_id

(integer) The ID of original product.

$translated_product_id

(integer) The ID of translated product.

Run actions after the post meta fields are being set for a duplicated product.

add_action( 'wcml_after_duplicate_product_post_meta', 'the_callback_function', 10, 3 );

There are three parameters being passed to this action:

$original_product_id

(integer) The ID of original product.

$translated_product_id

(integer) The ID of translated product.

$data

(array) The original product data.

Run your custom functions right after the translated product fields are updated.

add_action( 'wcml_update_extra_fields', 'the_callback_function', 10, 4 );

There are four parameters being passed to this action:

$original_product_id

(integer) The ID of original product.

$translated_product_id

(integer) The ID of translated product.

$translation_data

(array) The data of translated product.

$target_language

(string) The language code of translated product.

• Run actions before WCML syncs data (images, taxonomies, variations, etc) from original products to their translations.
• This action is called after wcml_before_sync_product.

add_action( 'wcml_before_sync_product_data', 'the_callback_function', 10, 3 );

There are three parameters being passed to this action:

$original_product_id

(integer) The ID of original product.

$translated_product_id

(integer) The ID of translated product.

$target_language

(string) The language code of translated product.

Allows the ability to override translating order items.

$translate_order_items

(bool) True if we should translate order items

$items

(WC_Order_Item[]) Order items

$order

(WC_Order) WC order

add_filter( 'wcml_should_translate_order_items', function ( $translate_order_items, $items, $order ) {
	return false;
}, 10, 3 );

Allows overriding of adjusted order item

$language

(string) Order item language to filter

$order

(WC_Order) WC order

add_filter( ‘wcml_should_save_adjusted_order_item_in_language’, function ( $adjusted_order_item, $item, $language_to_filter ) {
return false;
}, 10, 3 );

Allows overriding which item language to filter.

$translate

(bool) True if we should save adjusted order item.

$order

(WC_Order) WC order

$language_to_filter

(string) Language to filter

add_filter( 'wcml_get_order_items_language', function ( $language, $order ) {
	return 'es';
}, 10, 2 );

Allows overriding the translated shipping method title.

$should_translate_shipping

(bool) True if we should translate shipping method title.

$title

(string) Shipping title

$shipping_id

(string) Shipping ID

$language

(string) Language