zeroise( int $number, int $threshold ): string

Add leading zeros when necessary.


Description

If you set the threshold to ‘4’ and the number is ’10’, then you will get back ‘0010’. If you set the threshold to ‘4’ and the number is ‘5000’, then you will get back ‘5000’.

Uses sprintf to append the amount of zeros based on the $threshold parameter and the size of the number. If the number is large enough, then no zeros will be appended.


Top ↑

Parameters

$number int Required
Number to append zeros to if not greater than threshold.
$threshold int Required
Digit places number needs to be to not have zeros added.

Top ↑

Return

string Adds leading zeros to number if needed.


Top ↑

Source

File: wp-includes/formatting.php. View all references

function zeroise( $number, $threshold ) {
	return sprintf( '%0' . $threshold . 's', $number );
}


Top ↑

Changelog

Changelog
Version Description
0.71 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.