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.

Common

Name	Return	Summary
WireTextTools::collapse() WireTextTools::collapse(string $str) WireTextTools::collapse(string $str, array $options = [])	`string`	Collapse string to plain text that all exists on a single long line without destroying words/punctuation.
WireTextTools::diffMarkup() WireTextTools::diffMarkup(string $old, string $new) WireTextTools::diffMarkup(string $old, string $new, array $options = [])	`string`	Given two strings ($old and $new) return a diff string in HTML markup
WireTextTools::findPlaceholders() WireTextTools::findPlaceholders(string $str) WireTextTools::findPlaceholders(string $str, array $options = [])	`array` `bool`	Find and return all {placeholder} tags found in given string
WireTextTools::findReplaceEscapeChars() WireTextTools::findReplaceEscapeChars($str, array $escapeChars) WireTextTools::findReplaceEscapeChars($str, array $escapeChars, array $options = [])	`array`	Find escaped characters in $str, replace them with a placeholder, and return the placeholders
WireTextTools::fixUnclosedTags() WireTextTools::fixUnclosedTags(string $str) WireTextTools::fixUnclosedTags(string $str, bool $remove = true, array $options = [])	`string`	Remove (or close) unclosed HTML tags from given string
WireTextTools::getPunctuationChars() WireTextTools::getPunctuationChars() WireTextTools::getPunctuationChars(bool $sentence = false)	`array`	Get array of punctuation characters
WireTextTools::getVisibleLength() WireTextTools::getVisibleLength(string $str) WireTextTools::getVisibleLength(string $str)	`int`	Return visible length of string, which is length not counting markup or entities
WireTextTools::getWordAlternates() WireTextTools::getWordAlternates(string $word) WireTextTools::getWordAlternates(string $word, array $options = [])	`array`	Get alternate words for given word
WireTextTools::hasPlaceholders() WireTextTools::hasPlaceholders(string $str) WireTextTools::hasPlaceholders(string $str, array $options = [])	`bool`	Does the string have any {placeholder} tags in it?
WireTextTools::markupToText() WireTextTools::markupToText(string $str) WireTextTools::markupToText(string $str, array $options = [])	`string`	Convert HTML markup to readable text
WireTextTools::populatePlaceholders() WireTextTools::populatePlaceholders(string $str, $vars) WireTextTools::populatePlaceholders(string $str, $vars, array $options = [])	`string`	Given a string ($str) and values ($vars), populate placeholder “{tags}” in the string with the values
WireTextTools::truncate() WireTextTools::truncate(string $str, $maxLength) WireTextTools::truncate(string $str, $maxLength, $options = [])	`string`	Truncate string to given maximum length without breaking words

For hooks

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

Name	Return	Summary
WireTextTools::wordAlternates() WireTextTools::wordAlternates(string $word, array $options) WireTextTools::wordAlternates(string $word, array $options)	`array`	Hookable method to return alternate words for given word

PHP function alternates

Name	Return	Summary
WireTextTools::ltrim() WireTextTools::ltrim(string $str) WireTextTools::ltrim(string $str, string $chars = '')	`string`	Strip whitespace (or other characters) from the beginning of string only (aka left trim)
WireTextTools::rtrim() WireTextTools::rtrim(string $str) WireTextTools::rtrim(string $str, string $chars = '')	`string`	Strip whitespace (or other characters) from the end of string only (aka right trim)
WireTextTools::stripos() WireTextTools::stripos(string $haystack, string $needle) WireTextTools::stripos(string $haystack, string $needle, int $offset = 0)	`bool` `false` `int`	Find the position of the first occurrence of a case-insensitive substring in a string
WireTextTools::stristr() WireTextTools::stristr(string $haystack, string $needle) WireTextTools::stristr(string $haystack, string $needle, bool $beforeNeedle = false)	`false` `string`	Find the first occurrence of a string (case insensitive)
WireTextTools::strlen() WireTextTools::strlen(string $str) WireTextTools::strlen(string $str)	`int`	Get string length
WireTextTools::strpos() WireTextTools::strpos(string $haystack, string $needle) WireTextTools::strpos(string $haystack, string $needle, int $offset = 0)	`bool` `false` `int`	Find position of first occurrence of string in a string
WireTextTools::strrchr() WireTextTools::strrchr(string $haystack, string $needle) WireTextTools::strrchr(string $haystack, string $needle)	`false` `string`	Find the last occurrence of a character in a string
WireTextTools::strripos() WireTextTools::strripos(string $haystack, string $needle) WireTextTools::strripos(string $haystack, string $needle, int $offset = 0)	`bool` `false` `int`	Find the position of the last occurrence of a case-insensitive substring in a string
WireTextTools::strrpos() WireTextTools::strrpos(string $haystack, string $needle) WireTextTools::strrpos(string $haystack, string $needle, int $offset = 0)	`bool` `false` `int`	Find the position of the last occurrence of a substring in a string
WireTextTools::strstr() WireTextTools::strstr(string $haystack, string $needle) WireTextTools::strstr(string $haystack, string $needle, bool $beforeNeedle = false)	`false` `string`	Find the first occurrence of a string
WireTextTools::strtolower() WireTextTools::strtolower(string $str) WireTextTools::strtolower(string $str)	`string`	Make a string lowercase
WireTextTools::strtoupper() WireTextTools::strtoupper(string $str) WireTextTools::strtoupper(string $str)	`string`	Make a string uppercase
WireTextTools::substr() WireTextTools::substr(string $str, int $start) WireTextTools::substr(string $str, int $start, $length = null)	`string`	Get part of a string
WireTextTools::substrCount() WireTextTools::substrCount(string $haystack, string $needle) WireTextTools::substrCount(string $haystack, string $needle)	`int`	Count the number of substring occurrences
WireTextTools::trim() WireTextTools::trim(string $str) WireTextTools::trim(string $str, string $chars = '')	`string`	Strip 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:

Wire

API reference based on ProcessWire core version 3.0.236

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

Common

For hooks

PHP function alternates

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news