W3cubDocs

/WordPress

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.

Parameters

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

Return

string Adds leading zeros to number if needed.

Source

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

Changelog

Version Description
0.71 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/zeroise