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

Name	Type(s)	Description
`word`	string
`options`	array	`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.236