HH\Lib\Str\trim

Meta Engineer?

This is available as Str\trim in the www repository.

Returns the given string with whitespace stripped from the beginning and end

namespace HH\Lib\Str;

function trim(
  string $string,
  ?string $char_mask = NULL,
): string;

If the optional character mask isn't provided, the following characters will be stripped: space, tab, newline, carriage return, NUL byte, vertical tab.

Guide

Parameters

  • string $string
  • ?string $char_mask = NULL

Returns

  • string

Examples

$result = Str\trim("example_string    ");
echo($result);
//result: "example_string"

$result = Str\trim("   example_string  ");
echo($result);
//result: "example_string"