Function __global->array_peek

Definitions

sources/global3.php

  • Peek at a stack element.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$array array No No required parameter N/A N/A The stack to peek in
$depth_down integer No No 1 N/A N/A The depth into the stack we are peaking

Returns

  • The result of the peeking
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Peek at a stack element.
 *
 * @param  array $array The stack to peek in
 * @param  integer $depth_down The depth into the stack we are peaking
 * @return mixed The result of the peeking
 */

function array_peek(array $array, int $depth_down = 1)