array_shift()

array_shift()

function array_shift(array $array): mixed

Shifts an element off the beginning of array.

Parameters:

• $array (array), passed by reference

Returns: mixed

Availability

• Compiled (AOT): supported by the Elephc code generator.
• eval() (magician interpreter): supported — declarative interpreter builtin (crates/elephc-magician/src/interpreter/builtins/array/array_shift.rs).

No examples yet — check examples/ and showcases/ for usage patterns.

Internals

For how array_shift is implemented in the compiler, see the internals page.