HH\Map::get

Returns the value at the specified key in the current Map.

Description

public function get(
  Tk $k,
): ?Tv

Returns the value at the specified key in the current Map.

If the key is not present, null is returned. If you would rather have an exception thrown when a key is not present, then use at().

Parameters

  • Tk $k - the key from which to retrieve the value.

Return Values

  • ?Tv - The value at the specified key; or null if the key does not exist.

Examples

This example shows how get can be used to access the value at a key that may not exist:

<?hh

namespace Hack\UserDocumentation\API\Examples\Map\Get;

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

// Prints the value at key 'red'
var_dump($m->get('red'));

// Prints NULL since key 'blurple' doesn't exist
var_dump($m->get('blurple'));
Output
string(7) "#ff0000"
NULL