PHPackages                             synida/hunspell-php-wrapper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. synida/hunspell-php-wrapper

ActiveLibrary[Utility & Helpers](/categories/utility)

synida/hunspell-php-wrapper
===========================

PHP wrapper for HunSpell with threading support and custom dictionary support.

v0.2.10(3y ago)3446[3 issues](https://github.com/Synida/hunspell-php-wrapper/issues)MITPHPPHP ^7.0 || ^8.0CI failing

Since Mar 2Pushed 3y ago1 watchersCompare

[ Source](https://github.com/Synida/hunspell-php-wrapper)[ Packagist](https://packagist.org/packages/synida/hunspell-php-wrapper)[ Docs](https://github.com/Synida/hunspell-php-wrapper)[ RSS](/packages/synida-hunspell-php-wrapper/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (10)Dependencies (3)Versions (19)Used By (0)

[![Build Status](https://camo.githubusercontent.com/70af3bc7e76b733afdc4f33a99be6a7bb6687709f9d96cc5d56a1582228d81aa/68747470733a2f2f7472617669732d63692e6f72672f53796e6964612f68756e7370656c6c2d7068702d777261707065722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/Synida/hunspell-php-wrapper)[![Coverage Status](https://camo.githubusercontent.com/54d4a5db4fd66779d1f352d36e3188a1d52f508fb658e91ed5d0e75a4e4ef916/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f53796e6964612f68756e7370656c6c2d7068702d777261707065722f62616467652e737667)](https://coveralls.io/github/Synida/hunspell-php-wrapper)

hunspell-php-wrapper
====================

[](#hunspell-php-wrapper)

This library is a simple Hunspell spellchecker wrapper with multithreading support for spellchecking and a simple dictionary editor.

### Requirements

[](#requirements)

Hunspell - you won't be able to use this library without it.

If you wish like to use this module in multithreading mode, then you need the following too:

- PHP ^7.2 || ^8.0
- PHP with ZTS enabled
- [parallel](https://github.com/krakjoe/parallel) extension - you might have to compile it from source

### Installation

[](#installation)

```
composer require synida/hunspell-php-wrapper

```

During the installation a script will detect the CPU threads and the on the PC. Similarly, a minimum word per thread will be calculated, which will determine what is the minimum number of words from where it's worth using an extra thread (*with global average 91% accurate typing rate*)

This installation script will use the parallel module if it's installed, otherwise the thread number will be set to 1.

You may install your own dictionaries for the hunspell.

### Performance information

[](#performance-information)

With single threaded mode, the processing time for hunspell might take around 30sec - the default php request timout limit in the config - for around 15-16k words long text with the 91% typing accuracy rate.

With multithreading mode, doubling the CPU count will result in a bit less then double processing time as well, so the more CPU your environment has, the faster the processing will be.

Spellchecker
------------

[](#spellchecker)

### Basic usage:

[](#basic-usage)

```
$results = (new HunSpell(
    // encoding
    'en_GB.utf8',
    // dictionary file name without extension
    'en_GB',
    // response type
    HunSpell::JSON_RESPONSE,
    // max threads - ignored if the parallel module is dissabled
    1,
    // optimal minimum thread words - ignored if the thread number is 1
    Configuration::MIN_WORD_PER_THREAD
))->suggest();

```

Supported output formats: `array`, `json`

The output has an optimized size, if you are not sure what the attribute keys mean, you can find the key constants in the `HunSpell` class

### Advanced usage:

[](#advanced-usage)

**The parallel extension can't be used in web (*PHP CGI*) environment, thus the wrapper can be used only with PHP CLI too and cannot be used directly in web environment**

However, if you run a php script in a daemon(for example [supervisor](http://supervisord.org/introduction.html)) then you can communicate between the script(*running by PHP CLI*), and your web environment(*PHP CGI*) through a UDP port or a unix socket, thus you can use the multithreading function on the web environment. For optimized performance it's recommended to use single thread execution under the minimum optimal thread words, which should be adjusted with the communication time(*which should be measured*) between the background script and the web app.

### Good to know

[](#good-to-know)

It takes around 10 times as much time for an average word to calculate its suggestions for the Hunspell, then checking a correct word.

Creating individual threads takes time. Using the optimal minimum words per threads will barely increase the spell checking time if the spellchecked text is very short. Although the performance will increase with longer texts. By short text I mean something very close to `Configuration::MIN_WORD_PER_THREAD * n` threads (if it was calculated by you OR during the composer install, meaning the parallel was installed before that).

Dictionary editor
-----------------

[](#dictionary-editor)

Each dictionary have two files; a `.dic` and a `.aff` file. The .dic file starts with a number in the first line - this is the number of words the dictionary contains. The rest is the words of the dictionary. The .aff file is a ruleset for the dictionary, which describes language rules.

The hunspell can use one dictionary at once, and it's much slower to execute the spellchecking twice on two smaller dictionaries and merge the results, then execute it on one bigger dictionary.

The default dictionary paths for hunspell can be checked by using the `hunspell -D` command.

### Dictionary editor basic usage:

[](#dictionary-editor-basic-usage)

**\[Note\]:**File and word operations require rw file permission.

To create dictionary files(`.dic`/`.aff`/`.tpl`):

```
(new DictionaryEditor())->create($path);

```

To delete dictionary files(`.dic`/`.aff`/`.tpl`):

```
(new DictionaryEditor())->delete($path);

```

Adding new word to a dictionary/template:

```
$dictionaryEditor = new DictionaryEditor();

if (!$dictionaryEditor->addWord($path, $word)) {
    echo $dictionaryEditor->getMessage();
}

```

**\[Note\]:** Adding a word to a dictionary template(`.tpl`) won't add word count in the first line of the template, like it does for the dictionary, which is required for the correct functionality

**\[Note\]:** If the word exists in the dictionary or template, then the word won't be added again, nor exception will be generated, but the DictionaryEditor class' message property will be set

Deleting word from a dictionary/template:

```
$dictionaryEditor = new DictionaryEditor();

if (!$dictionaryEditor->deleteWord($path, $word)) {
    echo $dictionaryEditor->getMessage();
}

```

Editing word in a dictionary/template:

```
$dictionaryEditor = new DictionaryEditor();

if (!$dictionaryEditor->editWord($path, $word, $modifiedWord)) {
    echo $dictionaryEditor->getMessage();
}

```

**\[Note\]:**Target word can't be already existing dictionary word

Listing words:

```
(new DictionaryEditor())->listWords($path);

```

### Advanced usage:

[](#advanced-usage-1)

Using one dictionary is way faster, then executing the hunspell on multiple dictionaries. Editing language dictionaries are sometimes not a good idea, because the added/edited words will be gone as you upgrade it. Instead of editing the dictionaries directly, you can use templates, where you store your word and where you generate the dictionaries from. For example if you want an upgraded language dictionary(`upgraded_en_GB.dic`), then you can keep a language dictionary(`en_GB.dic`) and a template for your upgrade(`custom_words.tpl`). When you change the template files you can, you can relatively fast change the target word in the cache file/files - like the `upgraded_en_GB.dic` file - too. This implementation can be extended with multiple levels.

If you wish to store the dictionary files in the project folder, you can change the default folder paths in the source code of the Hunspell(`hunspell-master/src/tools/hunspell.cxx`), and recompile it like that.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~64 days

Recently: every ~79 days

Total

18

Last Release

1169d ago

PHP version history (2 changes)v0.2.6PHP ^7.0

v0.2.8PHP ^7.0 || ^8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/14039463?v=4)[Synida](/maintainers/Synida)[@Synida](https://github.com/Synida)

---

Top Contributors

[![Synida](https://avatars.githubusercontent.com/u/14039463?v=4)](https://github.com/Synida "Synida (62 commits)")

---

Tags

wrapperspellingmultithreadingspellcheckspellcheckerspell-checkerspell-checkhunspellthreading

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/synida-hunspell-php-wrapper/health.svg)

```
[![Health](https://phpackages.com/badges/synida-hunspell-php-wrapper/health.svg)](https://phpackages.com/packages/synida-hunspell-php-wrapper)
```

###  Alternatives

[tigitz/php-spellchecker

Provides an easy way to spellcheck multiple text source by many spellcheckers, directly from PHP

309498.4k1](/packages/tigitz-php-spellchecker)[simplesoftwareio/simple-qrcode

Simple QrCode is a QR code generator made for Laravel.

2.9k27.6M92](/packages/simplesoftwareio-simple-qrcode)[artisaninweb/laravel-soap

A SoapClient wrapper integration for Laravel

6314.5M12](/packages/artisaninweb-laravel-soap)[wapmorgan/morphos

A morphological solution for Russian and English language written completely in PHP. Provides classes to inflect personal names, geographical names, decline and pluralize nouns, generate cardinal and ordinal numerals, spell out money amounts and time.

8351.3M7](/packages/wapmorgan-morphos)[mekras/php-speller

PHP spell check library

68409.5k](/packages/mekras-php-speller)[mhor/php-mediainfo

PHP wrapper around the mediainfo command

120574.8k7](/packages/mhor-php-mediainfo)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)