Skip to main content

remove

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.

Removes the specified key (and associated value) from the current Map

public function remove(
  Tk $key,
): Map<Tk, Tv>;

This method is interchangeable with removeKey().

Future changes made to the current Map ARE reflected in the returned Map, and vice-versa.

Parameters​

  • Tk $key

Returns​

Examples​

Since Map::remove() returns a shallow copy of $m itself, you can chain a bunch of remove() calls together.

$m = Map {
  'red' => '#ff0000',
  'green' => '#00ff00',
  'blue' => '#0000ff',
  'yellow' => '#ffff00',
};

// Remove key 'red'
$m->remove('red');
\var_dump($m);

// Remove keys 'green' and 'blue'
$m->remove('green')->remove('blue');
\var_dump($m);