Back to Hhvm

MapWithKey

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

latest1.6 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 results of applying an operation to each key/value pair in the current Vector

Hack
public function mapWithKey<Tu>(
  (function(int, Tv): Tu) $callback,
): Vector<Tu>;

mapWithKey()'s result contains a value for every key/value pair in the current Vector; unlike filterWithKey(), where only values whose key/value pairs meet a certain criterion are included in the resulting Vector.

Parameters

  • (function(int, Tv): Tu) $callback

Returns

  • Vector<Tu> - A Vector containing the results of applying a user-specified operation to each key/value pair of the current Vector in turn.

Examples

This example shows how mapWithKey can be used to create a new Vector based on $v's keys and values:

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

$sentences = $v->mapWithKey(($index, $color) ==> "Color at {$index}: {$color}");

echo \implode("\n", $sentences)."\n";
<!-- HHAPIDOC -->