WireTextTools class

Specific text and markup tools for ProcessWire $sanitizer and elsewhere.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireTextTools class also inherits all the methods and properties of: Wire.

Show class?             Show args?        

Common

NameReturnSummary 
WireTextTools::collapse(string $str)
mixed stringCollapse string to plain text that all exists on a single long line without destroying words/punctuation. 
WireTextTools::diffMarkup(string $old, string $new)
stringGiven two strings ($old and $new) return a diff string in HTML markup 
WireTextTools::findPlaceholders(string $str)
array boolFind and return all {placeholder} tags found in given string 
WireTextTools::findReplaceEscapeChars($str, array $escapeChars)
arrayFind escaped characters in $str, replace them with a placeholder, and return the placeholders 
WireTextTools::fixUnclosedTags(string $str)
stringRemove (or close) unclosed HTML tags from given string 
WireTextTools::getPunctuationChars()
array stringGet array of punctuation characters 
WireTextTools::getVisibleLength(string $str)
intReturn visible length of string, which is length not counting markup or entities 
WireTextTools::getWordAlternates(string $word)
arrayGet alternate words for given word 
WireTextTools::hasPlaceholders(string $str)
boolDoes the string have any {placeholder} tags in it? 
WireTextTools::populatePlaceholders(string $str, $vars)
stringGiven a string ($str) and values ($vars), populate placeholder “{tags}” in the string with the values 
WireTextTools::truncate(string $str, $maxLength)
stringTruncate string to given maximum length without breaking words 

For hooks

These methods are only useful for hooking and should not be called directly.

PHP function alternates

NameReturnSummary 
WireTextTools::ltrim(string $str)
stringStrip whitespace (or other characters) from the beginning of string only (aka left trim) 
WireTextTools::rtrim(string $str)
stringStrip whitespace (or other characters) from the end of string only (aka right trim) 
WireTextTools::stripos(string $haystack, string $needle)
bool false intFind the position of the first occurrence of a case-insensitive substring in a string 
WireTextTools::stristr(string $haystack, string $needle)
false stringFind the first occurrence of a string (case insensitive) 
WireTextTools::strlen(string $str)
intGet string length 
WireTextTools::strpos(string $haystack, string $needle)
bool false intFind position of first occurrence of string in a string 
WireTextTools::strrchr(string $haystack, string $needle)
false stringFind the last occurrence of a character in a string 
WireTextTools::strripos(string $haystack, string $needle)
bool false intFind the position of the last occurrence of a case-insensitive substring in a string 
WireTextTools::strrpos(string $haystack, string $needle)
bool false intFind the position of the last occurrence of a substring in a string 
WireTextTools::strstr(string $haystack, string $needle)
false stringFind the first occurrence of a string 
WireTextTools::strtolower(string $str)
stringMake a string lowercase 
WireTextTools::strtoupper(string $str)
stringMake a string uppercase 
WireTextTools::substr(string $str, int $start)
stringGet part of a string 
WireTextTools::substrCount(string $haystack, string $needle)
intCount the number of substring occurrences 
WireTextTools::trim(string $str)
stringStrip whitespace (or other characters) from the beginning and end of a string 

Additional methods and properties

In addition to the methods and properties above, WireTextTools also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.168

Twitter updates

  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020
  • ProcessWire 3.0.168 core updates — More
    26 October 2020
  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020

Latest news

  • ProcessWire Weekly #341
    In the 341st issue of ProcessWire Weekly we're going to check out the latest processwire.com blog post, introduce upcoming commercial module called NiftyPasswordsPlus, and check out a brand new site of the week. Read on!
    Weekly.pw / 21 November 2020
  • New ProcessWire modules directory
    There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new.
    Blog / 20 November 2020
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits