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
| Name | Type(s) | Description |
|---|---|---|
word | string | |
options (optional) | array |
|
Return value
array
See Also
WireTextTools methods and properties
API reference based on ProcessWire core version 3.0.236