$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.

Usage

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

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

Arguments

NameType(s)Description
strstring
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

string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.187: This week we have some very useful new additions to both the core Repeater Fieldtype and the ProFields Repeater Matrix Fieldtype. This post covers all the details along with a couple of brief demonstration videos— More
    22 October 2021
  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021

Latest news

  • ProcessWire Weekly #389
    The 389th issue of ProcessWire Weekly we'll check out the latest core updates, introduce the Session Viewer module, and more. Read on!
    Weekly.pw / 23 October 2021
  • New Repeater and Repeater Matrix features
    This week we have some very useful new additions to both the core Repeater Fieldtype and the ProFields Repeater Matrix Fieldtype. This post covers all the details along with a couple of brief demonstration videos. 
    Blog / 22 October 2021
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer