Skip to main content

modified

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.

Create a new Locale object, based on an existing one

namespace HH\Lib\Locale;

function modified(
  Locale $orig,
  Category $cat,
  string $new,
): Locale;

The input should be of the form country[.encoding], for example: "C", en_US, en_US.UTF-8.

If present, the encoding currently must be 'UTF-8'.

The empty string is not considered a valid locale in Hack; the libc behavior is equivalent to get_native().

Parameters​

  • Locale $orig
  • Category $cat
  • string $new

Returns​

  • Locale