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.

Usage

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

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

Arguments

NameType(s)Description
wordstring
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

array

See Also


WireTextTools methods and properties

API reference based on ProcessWire core version 3.0.172

Twitter updates

  • This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings— More
    5 February 2021
  • ProcessWire 3.0.171 dev branch core updates – More
    22 January 2021
  • Preliminary 2021 roadmap in progress in this week’s update— More
    8 January 2021

Newest forum posts

Latest news

  • ProcessWire Weekly #352
    In the 352nd issue of ProcessWire Weekly we're going to check out the latest core updates available in ProcessWire 3.0.172, introduce a neat third party module called Admin Autosize Textareas, and more. Read on!
    Weekly.pw / 6 February 2021
  • ProcessWire 3.0.172 – Find faster and more efficiently
    This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings.
    Blog / 5 February 2021
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer