$sanitizer->text() method

Sanitize short string of text to single line without HTML

  • This sanitizer is useful for short strings of input text like like first and last names, street names, search queries, etc.

  • Please note the default 255 character max length setting.

  • If using returned value for front-end output, be sure to run it through $sanitizer->entities() first.

Example

$str = "
  <strong>Hello World</strong>
  How are you doing today?
";

echo $sanitizer->text($str);
// outputs: Hello World How are you doing today?

Usage

// basic usage
$string = $sanitizer->text(string $value);

// usage with all arguments
$string = $sanitizer->text(string $value, array $options = []);

Arguments

NameType(s)Description
valuestring

String value to sanitize

options (optional)array

Options to modify default behavior:

  • maxLength (int): maximum characters allowed, or 0=no max (default=255).
  • maxBytes (int): maximum bytes allowed (default=0, which implies maxLength*4).
  • stripTags (bool): strip markup tags? (default=true).
  • stripMB4 (bool): strip emoji and other 4-byte UTF-8? (default=false).
  • stripQuotes (bool): strip out any "quote" or 'quote' characters? Specify true, or character to replace with. (default=false)
  • stripSpace (bool|string): strip whitespace? Specify true or character to replace whitespace with (default=false). Since 3.0.105
  • reduceSpace (bool|string): reduce consecutive whitespace to single? Specify true or character to reduce to (default=false). Note that the reduceSpace option is an alternative to the stripSpace option, they should not be used together. Since 3.0.105
  • allowableTags (string): markup tags that are allowed, if stripTags is true (use same format as for PHP's strip_tags() function.
  • multiLine (bool): allow multiple lines? if false, then $newlineReplacement below is applicable (default=false).
  • convertEntities (bool): convert HTML entities to equivalent character(s)? (default=false). Since 3.0.105
  • newlineReplacement (string): character to replace newlines with, OR specify boolean true to remove extra lines (default=" ").
  • truncateTail (bool): if truncate necessary for maxLength, truncate from end/tail? Use false to truncate head (default=true). Since 3.0.105
  • inCharset (string): input character set (default="UTF-8").
  • outCharset (string): output character set (default="UTF-8").

Return value

string

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.133

Twitter updates

  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019
  • New post: This week we've added WEBP support in ProcessWire thanks to a GitHub pull request from Horst Nogajski. This enables you to have highly optimized image output in PW and I think you’ll really like the difference it makes— More
    24 May 2019

Latest news

  • ProcessWire Weekly #266
    In the 266th issue of ProcessWire Weekly we're going to take a closer look at ProcessWire 3.0.133 (dev), introduce a third party module called Repeater Images, and highlight a recently released site belonging to the Australian Antarctic Division. Read on!
    Weekly.pw / 15 June 2019
  • ProcessWire 3.0.133 core updates
    ProcessWire 3.0.133 adds a useful new $page->meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type. Read on for all the details, examples and screenshots.
    Blog / 14 June 2019
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH