Skip to main content

take

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 first $n values of the current Vector

public function take(
  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 the length of the current Vector, 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 that will be included in the returned Vector.

Returns​

Examples​

$v = Vector {'red', 'green', 'blue', 'yellow'};

// Take the first two elements
$take2 = $v->take(2);

\var_dump($take2);