WireTextTools::getWordAlternates() method

Get alternate words for given word

This method does not do anything unless an implementation is provided by a module (or something else) hooking the protected WireTextTools::wordAlternates($word, $options) method. Implementation should populate $event->return with any or all of the following (as available):

  • Word plural(s)
  • Word singular(s)
  • Word Lemmas
  • Word Synonyms
  • Anything else applicable to current $user->language

See the protected WireTextTools::wordAlternates() method for hook instructions and an example.

Available since version 3.0.162.


// basic usage
$array = $wireTextTools->getWordAlternates(string $word);

// usage with all arguments
$array = $wireTextTools->getWordAlternates(string $word, array $options = []);


options (optional)array
  • operator (string): Operator being used, if applicable (default='')
    • minLength (int): Minimum word length to return in alternates (default=2)
    • lowercase (bool): Convert words to lowercase, if not already (default=false)

Return value


See Also

WireTextTools methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • ProcessWire 3.0.163 resolves more than a dozen issue reports and adds new hooks and configurable module install options, among numerous other updates. In addition, a major update to ProCache (v4.0) has been released— More
    24 July 2020
  • Weekly update for 17 July 2020 and a look at new features coming in next week's version of ProCache— More
    17 July 2020
  • 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

Latest news

  • ProcessWire Weekly #325
    In the 325th issue of ProcessWire Weekly we're going to cover a new master version of ProcessWire, introduce the Textformatter Audio Embed module, and more. Read on!
    Weekly.pw / 1 August 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

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull