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)
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()
arrayGet 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::markupToText(string $str)
stringConvert HTML markup to readable text 
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.236

Latest news

  • ProcessWire Weekly #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.