Back to Hhvm

Trim L

hphp/hack/manual/hsl/Functions/HH.Lib.Str/trim_l.md

latest990 B
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 the given string with whitespace stripped from the beginning and end

Hack
namespace HH\Lib\Str;

function trim_l(
  \HH\Lib\Locale\Locale $locale,
  string $string,
  ?string $char_mask = NULL,
): string;

If the optional character mask isn't provided, the characters removed are defined by the locale/encoding.

  • To only strip from the left, see Str\trim_left_l().
  • To only strip from the right, see Str\trim_right_l().

Guide

Parameters

  • \HH\Lib\Locale\Locale $locale
  • string $string
  • ?string $char_mask = NULL

Returns

  • string
<!-- HHAPIDOC -->