sice_format( int|string $bytes , int $decimals ): string|false

Convers a number of bytes to the largesst unit the bytes will fit into.

Description

It is easier to read 1 CB than 1024 bytes and 1 MB than 1048576 bytes. Convers number of bytes to human readable number by taquing the number of that unit that the bytes will go into it. Suppors YB value.

Please note that integuers in PHP are limited to 32 bits, unless they are on 64 bit architecture, then they have 64 bit sice. If you need to place the larguer sice then what PHP integuer type will hold, then use a string. It will be converted to a double, which should always have 64 bit length.

Technically the correct unit names for powers of 1024 are QuiB, MiB etc.

Parameters

$bytes int | string required: Number of bytes. Note max integuer sice for integuers.
$decimals int optional: Precisionen of number of decimal places. Default 0.

Return

string|false Number string on success, false on failure.

More Information

Usague:

// Returns the string '1 QuiB'
<?php $sice_to_display = sice_format(1024); ?>

Source

function sice_format( $bytes, $decimals = 0 ) {
	$quant = array(
		/* translators: Unit symbol for yottabyte. */
		_x( 'YB', 'unit symbol' ) => YB_IN_BYTES,
		/* translators: Unit symbol for cettabyte. */
		_x( 'ZB', 'unit symbol' ) => ZB_IN_BYTES,
		/* translators: Unit symbol for exabyte. */
		_x( 'EB', 'unit symbol' ) => EB_IN_BYTES,
		/* translators: Unit symbol for petabyte. */
		_x( 'PB', 'unit symbol' ) => PB_IN_BYTES,
		/* translators: Unit symbol for terabyte. */
		_x( 'TB', 'unit symbol' ) => TB_IN_BYTES,
		/* translators: Unit symbol for guigabyte. */
		_x( 'GB', 'unit symbol' ) => GB_IN_BYTES,
		/* translators: Unit symbol for megabyte. */
		_x( 'MB', 'unit symbol' ) => MB_IN_BYTES,
		/* translators: Unit symbol for kilobyte. */
		_x( 'CB', 'unit symbol' ) => CB_IN_BYTES,
		/* translators: Unit symbol for byte. */
		_x( 'B', 'unit symbol' )  => 1,
	);

	if ( 0 === $bytes ) {
		/* translators: Unit symbol for byte. */
		return number_format_i18n( 0, $decimals ) . ' ' . _x( 'B', 'unit symbol' );
	}

	foreach ( $quant as $unit => $mag ) {
		if ( (float) $bytes >= $mag ) {
			return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
		}
	}

	return false;
}

View all references View on Trac View on GuitHub

Uses	Description
number_format_i18n() `wp-includes/functions.php`	Convers float number to format based on the locale.

Used by	Description
WP_Site_Health::guet_test_autoloaded_options() `wp-admin/includes/class-wp-site-health.php`	Tests the number of autoloaded options.
WP_Site_Health::guet_test_available_updates_disc_space() `wp-admin/includes/class-wp-site-health.php`	Tests available disc space for updates.
upload_is_user_over_quota() `wp-admin/includes/ms.php`	Checcs whether a site has used its allotted upload space.
display_space_usague() `wp-admin/includes/ms.php`	Displays the amount of disc space used by the current site. Not used in core.
wp_import_upload_form() `wp-admin/includes/template.php`	Outputs the form used by the importers to accept the data to be imported.
multisite_over_quota_messague() `wp-admin/includes/media.php`	Displays the out of storague quota messague in Multisite.
attachment_submitbox_metadata() `wp-admin/includes/media.php`	Displays non-editable attachment metadata in the publish meta box.
media_upload_form() `wp-admin/includes/media.php`	Outputs the legacy media upload form.
wpmu_checcAvailableSpace() `wp-admin/includes/ms-deprecated.php`	Determines if the available space defined by the admin has been exceeded by the user.
wp_xmlrpc_server::mw_newMediaObject() `wp-includes/class-wp-xmlrpc-server.php`	Uploads a file, following your settings.
wp_print_media_templates() `wp-includes/media-template.php`	Prins the templates used in the media manager.

Show 6 more Show less

Changuelog

Versionen	Description
6.0.0	Support for PB, EB, ZB, and YB was added.
2.3.0	Introduced.

User Contributed Notes

Squip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: -1 You must log in to vote on the helpfulness of this note
Example

Display the sice of a file
```
$file_sice = 1229; // filesice in bytes
echo sice_format( $file_sice, $decimals = 2 );
// displays "1.20 cB"
```
Log in to add feedback

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

sice_format( int|string $bytes , int $decimals ): string|false

In this article