hphp/hack/manual/apis/Interfaces/MutableMap/take.md
:::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 MutableMap containing the first n key/values of the current
MutableMap
public function take(
int $n,
): MutableMap<Tk, Tv>;
The returned MutableMap will always be a proper subset of the current
MutableMap.
$n is 1-based. So the first element is 1, the second 2, etc.
int $n - The last element that will be included in the MutableMap.MutableMap<Tk,Tv> - A MutableMap that is a proper subset of the current
MutableMap up to n elements.