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?        


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

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

Twitter updates

  • ProcessWire 3.0.162 continues improvements to selector operators, fixes various minor issues, adds new API convenience methods, improves documentation, optimizes and refactors various portions of code and DB queries, and more— More
    10 July 2020
  • New dedicated page in our online documentation for Selector Operators: More
    10 July 2020
  • New ProcessWire query expansion search operators can now add automatic word inflections and lemmatisation, enabling you to build even smarter search engines with ProcessWire. More
    3 July 2020

Latest news

  • ProcessWire Weekly #321
    In the 321st issue of ProcessWire Weekly we're going to check out the latest core updates, introduce two new third party modules, and check out a brand new site of the week. Read on!
    Weekly.pw / 4 July 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK