Function __global->array_shift

Definitions

sources_custom/phpstub.php

  • Shift an element off the beginning of array.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$array array Yes No required parameter N/A N/A The array

Returns

  • Shifted element (null: empty array given)
  • Type: ?mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Shift an element off the beginning of array.
 *
 * @param  array $array The array
 * @return ?mixed Shifted element (null: empty array given)
 */
function array_shift(array &$array)