ini_parse_quantity()
ini_parse_quantity() — Get interpreted size from ini shorthand syntax.
Built-in function of PHP 8.5. The manual lists it as available in PHP 8 >= 8.2.0. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
What it does
Returns the interpreted size in bytes on success from an ini shorthand.
Signature
ini_parse_quantity(string $shorthand): int
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $shorthand | string | Ini shorthand to parse, must be a number followed by an optional multiplier. The following multipliers are supported: k/K (1024), m/M (1048576), g/G (1073741824). The number can be a decimal, hex (prefixed with 0x or 0X), octal (prefixed with 0o, 0O or 0) or binary (prefixed with 0b or 0B) |
Return value
Returns the interpreted size in bytes as an int.
Example
A runnable snippet:
var_dump(ini_parse_quantity('1024')); var_dump(ini_parse_quantity('1024M')); var_dump(ini_parse_quantity('512K')); var_dump(ini_parse_quantity('0xFFk')); var_dump(ini_parse_quantity('0b1010k')); var_dump(ini_parse_quantity('0o1024')); var_dump(ini_parse_quantity('01024')); var_dump(ini_parse_quantity('Foobar')); var_dump(ini_parse_quantity('10F'));
Output:
int(1024) int(1073741824) int(524288) int(261120) int(10240) int(532) int(532) Warning: Invalid quantity "Foobar": no valid leading digits, interpreting as "0" for backwards compatibility int(0) Warning: Invalid quantity "10F": unknown multiplier "F", interpreting as "10" for backwards compatibility int(10)
See also
All PHP 8.5 built-in functions
Reference card built from the PHP manual page ini_parse_quantity() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.