Function __global->spellcheck_initialise

Definitions

sources/spelling.php

  • Initialise the spellcheck engine.Will re-use connections, so if you want to call this call add_spellchecker_words_temp with it, before calling a spellchecker, that works.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$lang ?ID_TEXT No No Null N/A N/A Language to check in (null: current language)

Returns

  • Spellchecker (null: error)
  • Type: ?mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Initialise the spellcheck engine.Will re-use connections, so if you want to call this call add_spellchecker_words_temp with it, before calling a spellchecker, that works.
 *
 * @param  ?ID_TEXT $lang Language to check in (null: current language)
 * @return ?mixed Spellchecker (null: error)
 */
function spellcheck_initialise(?string $lang = null)