How to use number_format_i18n filter in WordPress

number_format_i18n filter

Filters the number formatted based on the locale.

To use the number_format_i18n filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_number_format_i18n_defaults which takes 3 parameters and we registered using add_filter. The first parameter number_format_i18n is the name of the hook, The second parameter weplugins_modify_number_format_i18n_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove the number_format_i18n filter.

Parameters

Below are the 3 parameters required to use this hook.

• $formatted : (string) Converted number in string format.
• $number : (float) The number to convert based on locale.
• $decimals : (int) Precision of the number of decimal places.

Live Example 1: Basic Usage

Below is an example of how you can use this hook.

	function weplugins_modify_number_format_i18n_defaults($formatted, $number, $decimals) { 
		// Update the $formatted variable according to your website requirements and return this variable. You can modify the $formatted variable conditionally too if you want.
		return $formatted; 
	}
	// Add the filter
	add_filter( "number_format_i18n", "weplugins_modify_number_format_i18n_defaults", 10, 3 );
	

Live Example 2: Removing the Hook

To remove a hook callback, use the example below.

	remove_filter( "number_format_i18n", "weplugins_modify_number_format_i18n_defaults", 10, 3 );
	

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Live Example 3: Conditional Formatting

Here is how you can conditionally modify the formatted number.

	function weplugins_conditional_number_format_i18n($formatted, $number, $decimals) { 
		if($number > 1000) {
			$formatted = number_format($number, $decimals, '.', ',');
		}
		return $formatted; 
	}
	// Add the filter
	add_filter( "number_format_i18n", "weplugins_conditional_number_format_i18n", 10, 3 );
	

Contact Us

If you need customization or are having any trouble using this hook, please contact us and we’d be happy to assist you.