wireBytesStr() function

Given a quantity of bytes (int), return readable string that refers to quantity in bytes, kB, MB, GB, etc.

Usage

// basic usage
$string = wireBytesStr(int $bytes);

// usage with all arguments
$string = wireBytesStr(int $bytes, $small = false, $options = array);

Arguments

NameType(s)Description
bytesint

Quantity in bytes

small (optional)bool, int, array

Make returned string as small as possible? (default=false)

  • true (bool): Yes, make returned string as small as possible.
  • 1 (int): Same as true but with space between number and unit label.
  • Or optionally specify the $options argument here if you do not need the $small argument.
options (optional)array, int

Options to modify default behavior, or if an integer then decimals option is assumed:

  • decimals (int): Number of decimals to use in returned value (default=0).
  • decimal_point (string|null): Decimal point character, or null to detect from locale (default=null).
  • thousands_sep (string|null): Thousands separator, or null to detect from locale (default=null).
  • small (bool): If no $small argument was specified, you can optionally specify it in this $options array.
  • type (string): To force return value as specific type, specify one of: bytes, kilobytes, megabytes, gigabytes; or just: b, k, m, g. (3.0.148+ only)

Return value

string


Functions methods and properties

API reference based on ProcessWire core version 3.0.178

Twitter updates

  • ProcessWire 3.0.180 core updates– More
    18 June 2021
  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021

Latest news

  • ProcessWire Weekly #372
    In the 372nd issue of ProcessWire Weekly we're going to introduce a couple of new third party modules, check out a very interesting new project from Ryan, and more. Read on!
    Weekly.pw / 26 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer