php8.5
Home/ Manual/ pspell / functions/ pspell_store_replacement

pspell_store_replacement

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8)

Store a replacement pair for a word

Description

pspell_store_replacement(PSpell\Dictionary $dictionary, string $misspelled, string $correct): bool

pspell_store_replacement() stores a replacement pair for a word, so that replacement can be returned by pspell_suggest() later. In order to be able to take advantage of this function, you have to use pspell_new_personal() to open the dictionary. In order to permanently save the replacement pair, you have to use pspell_config_personal() and pspell_config_repl() to set the path where to save your custom wordlists, and then use pspell_save_wordlist() for the changes to be written to disk.

Parameters

dictionary

Pspell-dictionary

misspelled

The misspelled word.

correct

The fixed spelling for the misspelled word.

Return Values

Success

Changelog

VersionDescription

Examples

pspell_store_replacement()

php
<?php
$pspell_config = pspell_config_create("en");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
$pspell = pspell_new_config($pspell_config);

pspell_store_replacement($pspell, $misspelled, $correct);
pspell_save_wordlist($pspell);
?>

Notes

Note

This function will not work unless you have pspell .11.2 and aspell .32.5 or later.

Source: reference/pspell/functions/pspell-store-replacement.xml · from the official PHP manual (php/doc-en)