Definition and Usage
- PHP Version
- 4+
The sizeof() function counts the number of elements (array length) in an array and returns an integer.
Basic Example
/* Numerically indexed array */
$array_1 = [1, 2, 3, 4, 5];
var_dump(sizeof($array_1)); // int(5)
$array_2 = [];
var_dump(sizeof($array_2)); // int(0)
$array_2[0] = 1;
$array_2[1] = 2;
var_dump(sizeof($array_2)); // int(2)
/* Associative array */
$associative_array = [
'name' => 'John Doe',
'age' => 30,
'city' => 'New York'
];
var_dump(sizeof($associative_array)); // int(3)
/* Multidimensional array */
$multi_dimensional_array = [
[1, 2, 3],
[4, 5, 6],
[7, 8, 9]
];
var_dump(sizeof($multi_dimensional_array)); // int(3)
// Returns the total number of elements, including all nested array elements
var_dump(sizeof($multi_dimensional_array, 1)); // int(12)
Syntax
sizeof(Countable|array $value, int $mode = COUNT_NORMAL): int
Parameters
$value |
The array, or the object implementing the Countable interface, whose elements are to be counted. |
|---|---|
$mode |
Optional.
This parameter can accept one of the following constants: COUNT_NORMAL (or 0) or COUNT_RECURSIVE (or 1). The default is COUNT_NORMAL.
|
Return Values
Returns the number of elements as an integer.
Setting the Element Counting Mode for Multidimensional Arrays
A multidimensional array that includes sub-arrays is an array where elements are arrays that can themselves contain other elements. To include all elements inside nested arrays when counting, set the second parameter of the sizeof() function to COUNT_RECURSIVE or 1.
With this setting, the sizeof() function recursively counts all elements in the multidimensional array and returns the total number of elements, including those inside nested arrays.
$multi_dimensional_array = [
[1, 2, 3],
[4, 5, 6],
[7, 8, 9]
];
var_dump(sizeof($multi_dimensional_array)); // int(3)
// Returns the total number of elements, including all nested array elements
var_dump(sizeof($multi_dimensional_array, 1)); // int(12)