WireTextTools::getWordAlternates()

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)](/api/ref/wire-WireTextTools::wordAlternates($word, $options)-tools/word-alternates/) 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.251