Back to Hhvm

Skip

hphp/hack/manual/apis/Classes/HH/Vector/skip.md

latest1.7 KB
Original Source

:::info[Note] This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information. :::

Returns a Vector containing the values after the $n-th element of the current Vector

Hack
public function skip(
  int $n,
): Vector<Tv>;

The returned Vector will always be a subset (but not necessarily a proper subset) of the current Vector. If $n is greater than or equal to the length of the current Vector, the returned Vector will contain no elements. If $n is negative, the returned Vector will contain all elements of the current Vector.

$n is 1-based. So the first element is 1, the second 2, etc.

Parameters

  • int $n - The last element to be skipped; the $n+1 element will be the first one in the returned Vector.

Returns

  • Vector<Tv> - A Vector that is a subset of the current Vector containing values after the specified $n-th element.

Examples

basic-usage.hack
$v = Vector {'red', 'green', 'blue', 'yellow'};

// Create a new Vector after skipping the first two elements ('red' and 'green')
$skip2 = $v->skip(2);

\var_dump($skip2);
<!-- HHAPIDOC -->