array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.pspell-clear-session.php', 1 => 'pspell_clear_session', 2 => 'Clear the current session', ), 'up' => array ( 0 => 'ref.pspell.php', 1 => 'Pspell Functions', ), 'prev' => array ( 0 => 'function.pspell-check.php', 1 => 'pspell_check', ), 'next' => array ( 0 => 'function.pspell-config-create.php', 1 => 'pspell_config_create', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/pspell/functions/pspell-clear-session.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

pspell_clear_session

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

pspell_clear_session — Clear the current session

Description

pspell_clear_session(PSpell\Dictionary $dictionary): bool

pspell_clear_session() clears the current session. The current wordlist becomes blank, and, for example, if you try to save it with pspell_save_wordlist(), nothing happens.

Parameters

dictionary

An PSpell\Dictionary instance.

Return Values

Returns true on success or false on failure.

Changelog

Version Description
8.1.0 The dictionary parameter expects an PSpell\Dictionary instance now; previously, a resource was expected.

Examples

Example #1 pspell_add_to_personal() Example

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

pspell_add_to_personal($pspell, "Vlad");
pspell_clear_session($pspell);
pspell_save_wordlist($pspell); //"Vlad" will not be saved
?>