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.167

Twitter updates

  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020
  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020

Latest news

  • ProcessWire Weekly #336
    In the 336th issue of ProcessWire Weekly we're going to introduce the Stripe action for FormBuilder, highlight some recent forum topics and other online resources, and more. Read on!
    Weekly.pw / 17 October 2020
  • Stripe Payment Processor for FormBuilder
    This week a second new module for processing Stripe payments has been added to FormBuilder. We’ll take a closer look at it in this blog post, plus we’ve got a demo of it here too.
    Blog / 16 October 2020
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits