Skip to content

Instantly share code, notes, and snippets.

@RadGH
Last active August 8, 2024 20:33
Show Gist options
  • Save RadGH/84edff0cc81e6326029c to your computer and use it in GitHub Desktop.
Save RadGH/84edff0cc81e6326029c to your computer and use it in GitHub Desktop.
Short Number Formatter for PHP (1000 to 1k; 1m; 1b; 1t)
<?php
// Converts a number into a short version, eg: 1000 -> 1k
// Based on: http://stackoverflow.com/a/4371114
function number_format_short( $n, $precision = 1 ) {
if ($n < 900) {
// 0 - 900
$n_format = number_format($n, $precision);
$suffix = '';
} else if ($n < 900000) {
// 0.9k-850k
$n_format = number_format($n / 1000, $precision);
$suffix = 'K';
} else if ($n < 900000000) {
// 0.9m-850m
$n_format = number_format($n / 1000000, $precision);
$suffix = 'M';
} else if ($n < 900000000000) {
// 0.9b-850b
$n_format = number_format($n / 1000000000, $precision);
$suffix = 'B';
} else {
// 0.9t+
$n_format = number_format($n / 1000000000000, $precision);
$suffix = 'T';
}
// Remove unecessary zeroes after decimal. "1.0" -> "1"; "1.00" -> "1"
// Intentionally does not affect partials, eg "1.50" -> "1.50"
if ( $precision > 0 ) {
$dotzero = '.' . str_repeat( '0', $precision );
$n_format = str_replace( $dotzero, '', $n_format );
}
return $n_format . $suffix;
}
/*
Example Usage:
number_format_short(7201); // Output: 7.2k
Demo:
echo '<table>';
for($d = 0; $d < 16; $d++ ) {
$n = intval("09" . str_repeat( "0", $d ));
$n = $n / 10;
echo number_format_short($n) .'<br>'; // 0.9
$n = intval("1" . str_repeat( "0", $d ));
echo number_format_short($n) .'<br>'; // 1.0
$n = intval("11" . str_repeat( "0", $d ));;
$n = $n / 10;
echo number_format_short($n) .'<br>'; // 1.1
}
echo '</table>';
Demo Output:
0.9
1
1.1
9
10
11
90
100
110
0.9K
1K
1.1K
9K
10K
11K
90K
100K
110K
0.9M
1M
1.1M
9M
10M
11M
90M
100M
110M
0.9B
1B
1.1B
9B
10B
11B
90B
100B
110B
0.9T
1T
1.1T
9T
10T
11T
90T
100T
110T
900T
1,000T
1,100T
*/
@hayjay
Copy link

hayjay commented Aug 16, 2019

@hassanamirkhan Thanks for this beautiful function.

@hassanamirkhan
Copy link

@havutcuoglu, @hayjay and @sandervanhooft you're most welcome guys!

@hassanamirkhan
Copy link

@hassanamirkhan in your snippet if ($n > 0 && $n < 1000) { should be if ($n >= 0 && $n < 1000) { to include the case when $n = 0.

So:

/**
 * @param $n
 * @return string
 * Use to convert large positive numbers in to short form like 1K+, 100K+, 199K+, 1M+, 10M+, 1B+ etc
 */
function number_format_short( $n ) {
	if ($n >= 0 && $n < 1000) {
		// 1 - 999
		$n_format = floor($n);
		$suffix = '';
	} else if ($n >= 1000 && $n < 1000000) {
		// 1k-999k
		$n_format = floor($n / 1000);
		$suffix = 'K+';
	} else if ($n >= 1000000 && $n < 1000000000) {
		// 1m-999m
		$n_format = floor($n / 1000000);
		$suffix = 'M+';
	} else if ($n >= 1000000000 && $n < 1000000000000) {
		// 1b-999b
		$n_format = floor($n / 1000000000);
		$suffix = 'B+';
	} else if ($n >= 1000000000000) {
		// 1t+
		$n_format = floor($n / 1000000000000);
		$suffix = 'T+';
	}

	return !empty($n_format . $suffix) ? $n_format . $suffix : 0;
}

@sandervanhooft yep we can add $n >= 0.
But if you check ternary condition in return statement it is already handling $n=0 case.

@regifr
Copy link

regifr commented Oct 18, 2019

love this function thanks

@mauro-baptista
Copy link

I made an approach to use as a realtime facade in Laravel, but I've adapted it to be used in any project. Feel free to take a look here: https://gist.github.com/maurobaptista/1c7ec5e71bac9bd20137cd01d390bdaa

@chornobils
Copy link

just use (new NumberFormatter('en_US', NumberFormatter::PADDING_POSITION))->format($count)

@parth391
Copy link

Division is more costly than multiplication, https://stackoverflow.com/questions/4125033/floating-point-division-vs-floating-point-multiplication#answer-4125074

For better performance use multiplication where its possible.

// Converts a number into a short version, eg: 1000 -> 1k
// Based on: http://stackoverflow.com/a/4371114
function number_format_short($n, $precision = 1) {
    if ($n < 900) {
        // 0 - 900
        $n_format = number_format($n, $precision);
        $suffix = '';
    } elseif ($n < 900000) {
        // 0.9k-850k
        $n_format = number_format($n * 0.001, $precision);
        $suffix = 'K';
    } elseif ($n < 900000000) {
        // 0.9m-850m
        $n_format = number_format($n * 0.000001, $precision);
        $suffix = 'M';
    } elseif ($n < 900000000000) {
        // 0.9b-850b
        $n_format = number_format($n * 0.000000001, $precision);
        $suffix = 'B';
    } else {
        // 0.9t+
        $n_format = number_format($n * 0.000000000001, $precision);
        $suffix = 'T';
    }

    // Remove unecessary zeroes after decimal. "1.0" -> "1"; "1.00" -> "1"
    // Intentionally does not affect partials, eg "1.50" -> "1.50"
    if ($precision > 0) {
        $dotzero = '.' . str_repeat('0', $precision);
        $n_format = str_replace($dotzero, '', $n_format);
    }

    return $n_format . $suffix;
}

@DerekBuntin
Copy link

I created a gist after reviewing the original method and included a Laravel Helper Class.

The match expression introduced in PHP 8.0 evaluates the respective result of the first arm whose condition evaluates to true. The default keyword is used to cover any remaining cases if needed. Here, the match expression replaced the if and else if conditions, making the function easier to read and more optimised. It also eliminates the need to call number_format multiple times with different parameters.

https://gist.github.com/DerekBuntin/f78de4eb1ad90bc3c33dcc61bd02d5b5

@kingsloi
Copy link

kingsloi commented Aug 8, 2024

@DerekBuntin thanks 🍻! Your link is linked incorrectly and 404s - copy and pasting the URL works though!

https://gist.github.com/DerekBuntin/f78de4eb1ad90bc3c33dcc61bd02d5b5

@DerekBuntin
Copy link

@kingsloi strange, I just clicked the link and it took me through to the page? Glad you got there though :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment