$sanitizer->trim() method

Trim off all known UTF-8 whitespace types (or given chars) from beginning and ending of string

Like PHP’s trim() but works with multibyte strings and recognizes all types of UTF-8 whitespace as well as HTML whitespace entities. This method also optionally accepts an array for $chars argument which enables you to trim out string sequences greater than one character long.

If you do not need an extensive multibyte trim, use PHP’s trim() instead because this takes more overhead. PHP multibyte support (mb_string) is strongly recommended if using this function.

Available since version 3.0.124.


// basic usage
$string = $sanitizer->trim(string $str);

// usage with all arguments
$string = $sanitizer->trim(string $str, $chars = '', string $method = 'trim');


chars (optional)string, array

Array or string of chars to trim, or omit (blank string) for all whitespace (includes UTF-8 and HTML-entity whitespace too).

method (optional)string

Trim method, one of "trim" (both), "rtrim" (right-only) or "ltrim" (left-only). Or just "t", "r", "l" is also fine. 3.0.168+

Return value


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani