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

Latest news

  • ProcessWire Weekly #354
    In the 354th issue of ProcessWire Weekly we're going to check out the latest core updates, properly introduce the ProcessCKInlineComplete module, and dig into a brand new site of the week. Read on!
    Weekly.pw / 20 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

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani