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

Twitter updates

  • ProcessWire 3.0.163 resolves more than a dozen issue reports and adds new hooks and configurable module install options, among numerous other updates. In addition, a major update to ProCache (v4.0) has been released— More
    24 July 2020
  • Weekly update for 17 July 2020 and a look at new features coming in next week's version of ProCache— More
    17 July 2020
  • ProcessWire 3.0.162 continues improvements to selector operators, fixes various minor issues, adds new API convenience methods, improves documentation, optimizes and refactors various portions of code and DB queries, and more— More
    10 July 2020

Latest news

  • ProcessWire Weekly #325
    In the 325th issue of ProcessWire Weekly we're going to cover a new master version of ProcessWire, introduce the Textformatter Audio Embed module, and more. Read on!
    Weekly.pw / 1 August 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer