WireNumberTools::bytesToStr() method

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

Available since version 3.0.214. All versions can also use the wireBytesStr() function

Usage

// basic usage
$string = $wireNumberTools->bytesToStr($bytes);

// usage with all arguments
$string = $wireNumberTools->bytesToStr($bytes, $options = []);

Arguments

NameType(s)Description
bytesint, string

Quantity in bytes (int) or any string accepted by strToBytes method.

options (optional)array, int

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

  • decimals (int|null): Number of decimals to use in returned value or NULL for auto (default=null). When null (auto) a decimal value of 1 is used when appropriate, for megabytes and higher (3.0.214+).
  • 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|int): Make returned string as small as possible? false=no, true=yes, 1=yes with space (default=false)
  • labels (array): Labels to use for units, indexed by: b, byte, bytes, k, m, g, t
  • type (string): To force return value as specific type, specify one of: bytes, kilobytes, megabytes, gigabytes, terabytes; or just: b, k, m, g, t. (3.0.148+ only, terabytes 3.0.214+).

Return value

string


WireNumberTools methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #552
    In the 552nd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, take a quick look at a new e-commerce solution for ProcessWire, and more. Read on!
    Weekly.pw / 7 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer