Skip to main content

filterWithKey

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 an ImmMap containing the values of the current ImmMap that meet a supplied condition applied to its keys and values

public function filterWithKey(
  (function(Tk, Tv): bool) $callback,
): ImmMap<Tk, Tv>;

Only keys and values that meet a certain criteria are affected by a call to filterWithKey(), while all values are affected by a call to mapWithKey().

The keys associated with the current ImmMap remain unchanged in the returned ImmMap; the keys will be used in the filtering process only.

Parameters​

  • (function(Tk, Tv): bool) $callback

Returns​

  • ImmMap<Tk,Tv> - an ImmMap containing the values after a user-specified condition is applied to the keys and values of the current ImmMap.

Examples​

See Map::filterWithKey for usage examples.