Skip to content
Docs
Get RestroPress

Filter

rpress_sanitize_amount_decimals

Updated
On this page

Filters the number of decimals used when sanitizing an amount.

Runs in rpress_sanitize_amount with a default of 2. RestroPress hooks rpress_currency_decimal_filter at priority 10, which sets zero decimals for currencies such as JPY. The result is passed to number_format.

Parameters#

ParameterTypeDescription
$decimalsintNumber of decimals. Defaults to 2.
$amountint|stringThe amount being sanitized.

Return value#

int. The number of decimals.

Example#

function my_sanitize_amount_decimals( $decimals, $amount ) {
	return 3;
}
add_filter( 'rpress_sanitize_amount_decimals', 'my_sanitize_amount_decimals', 20, 2 );

Source#

Applied in:

  • includes/formatting.php (line 49), in rpress_sanitize_amount()

See also#

Was this page helpful?