rpress_format_payment_number

Filters the formatted order number when sequential numbering is enabled.

Runs in rpress_format_payment_number() after the prefix, integer number and postfix have been concatenated. It only runs when 'Sequential Order Numbers' has a starting value and the number is numeric; otherwise the number is returned untouched. The prefix and postfix come from the 'Sequential Number Prefix' and 'Sequential Number Postfix' settings.

Parameters#

Parameter	Type	Description
$formatted_number	string	The prefix, number and postfix joined together.
$prefix	string	The configured prefix.
$number	int	The numeric order number.
$postfix	string	The configured postfix.

Return value#

string. The formatted order number.

Example#

add_filter( 'rpress_format_payment_number', 'my_pad_payment_number', 10, 4 );
function my_pad_payment_number( $formatted_number, $prefix, $number, $postfix ) {
	return $prefix . str_pad( (string) $number, 6, '0', STR_PAD_LEFT ) . $postfix;
}

Source#

Applied in:

• includes/payments/functions.php (line 1445), in rpress_format_payment_number()

See also#

• rpress_remove_payment_prefix_postfix
• rpress_payment_number