array_unshift

Function • Params and return types changed in PHP 8.0

Prepend one or more elements to the beginning of an array.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

array_unshift Function synopsis

array_unshift(array &$array, mixed ...$values): int

Parameters

$array

Passed by referenceTypearray

The input array.

$values

Variadic, OptionalTypemixed

The values to prepend.

Note that the parameter $array is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typeint

Returns the new number of elements in the $array.

Changes to the array_unshift Function

PHP 8.0

  • Return type added: int
  • Parameter name of parameter #1 changed: $stack to $array
  • Parameter type added for parameter #1 ($array): array
  • Parameter name of parameter #2 changed: $vars to $values
  • Parameter type added for parameter #2 ($values): mixed
- array_unshift(&$stack, ...$vars)
+ array_unshift(array &$array, mixed ...$values): int

array_unshift Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes