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

pspell_config_personal

PHP function Edit on GitHub ✎

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

Set a file that contains personal wordlist

Description

pspell_config_personal(PSpell\Config $config, string $filename): bool

Set a file that contains personal wordlist. The personal wordlist will be loaded and used in addition to the standard one after you call pspell_new_config(). The file is also the file where pspell_save_wordlist() will save personal wordlist to.

pspell_config_personal() should be used on a config before calling pspell_new_config().

Parameters

config

Pspell-config

filename

The personal wordlist. If the file does not exist, it will be created. The file should be writable by whoever PHP runs as (e.g. nobody).

Return Values

Success

Changelog

VersionDescription

Examples

pspell_config_personal()

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

Notes

Note

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

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