WireTextTools::wordAlternates() method

Hookable method to return alternate words for given word

This hookable method is separate from the public getWordAlternates() method so that we can provide predictable and already-populated $options to whatever is hooking this, as as provide some additional QA with the return value from modules/hooks.

It is fine if the return value contains duplicates, the original word, or too-short words, as the calling getWordAlternates() takes care of those before returning words to user. Basically, hooks can ignore the $options argument, unless they need to know the operator, which may or may not be provided by the caller.

In hook implementation, avoid deleting what’s already present in $event->return just in case multiple hooks are adding words.

Available since version 3.0.162.

Example

// Contrived example of how to implement
$wire->addHookAfter('WireTextTools::wordAlternates', function(HookEvent $event) {
  $word = $event->arguments(0); // string: word requested alternates for
  $words = $event->return; // array: existing return value

  $cats = [ 'cat', 'cats', 'kitty', 'feline', 'felines' ];
  $dogs = [ 'dog', 'dogs', 'doggy', 'canine', 'canines' ];

  if(in_array($word, $cats)) {
    $words = array_merge($words, $cats);
  } else if(in_array($word, $dogs)) {
    $words = array_merge($words, $dogs);
  }

  $event->return = $words;
});

// Test it out
$words = $sanitizer->getTextTools()->getWordAlternates('cat');
echo implode(', ', $words); // outputs: cats, kitty, kitten, feline, felines

Usage

$array = $wireTextTools->wordAlternates(string $word, array $options);

Arguments

NameType(s)Description
wordstring
optionsarray
  • operator (string): Operator being used, if applicable (default='')

Return value

array


Hooking WireTextTools::wordAlternates(…)

You can add your own hook events that are executed either before or after the WireTextTools::wordAlternates(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each WireTextTools::wordAlternates(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireTextTools::wordAlternates', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireTextTools = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $word = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $word);
  $event->arguments(1, $options);
});

Hooking after

The 'after' hooks are called immediately after each WireTextTools::wordAlternates(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireTextTools::wordAlternates', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireTextTools = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $word = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

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

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer