Function __global->run_spellcheck
Definitions
sources/spelling.php
- Run a spellcheck on some text.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $text | string | required parameter | N/A | N/A | Text to scan for words in (should be plain text, not be HTML or Comcode text) |
| $lang | ?ID_TEXT | Null | N/A | N/A | Language to check in (null: current language) |
| $skip_known_words_in_db | boolean | True | N/A | N/A | Whether to avoid spellchecking known keywords etc |
| $provide_corrections | boolean | True | N/A | N/A | Whether to provide corrections |
| $unicode_accepted | boolean | True | N/A | N/A | Whether Unicode is accepted |
Return
- A map of misspellings, lower case bad word => array of corrections (null: error)
- Type: ?array
- Set: N/A
- Range: N/A