Badwords PHP is small lightweight PHP library for detecting "bad" words, e.g. profanity, in content.

Aside from the obvious matching if a word is present in a string, the filter also tries to detect words similar to those in the list, e.g. gl@d and glad.

The library is designed to be highly configurable, from the word lists used to the character replacement configuration at the heart of the filter.

Note: At present the default configuration provided is not a bulletproof/catch-all solution, but it will catch most variations. This will become more robust over time.

• The library is only supported on PHP 5.3.0 and up.
• It has been assumed an autoloader will be present. If you require one, you can find one here.

Simply download the library and add the src folder to your project.

The simplest way to use the library is as follows,

$dictionary = new \Badword\Dictionary\Php('path/to/dictionary_list.php');
$config = new \Badword\Filter\Config\Standard();
$filter = new \Badword\Filter($dictionary, $config);

$result = $filter->filter('My content...');
$result->getRiskLevel();
$result->getMatches();
$result->getMatchesAndRiskLevels();
$result->getHighlightedContent();

Explained,

• First load your list of "bad" words using the Dictionary objects, or create your own and implement the Dictionary interface.
• Define a configuration for the filter to use (a default Standard configuration is provided).
• Create the Filter passing your dictionary(s) and config.
• Filter your content using the filter() method.
• Use the Result object to analyse your content.

To run the tests, make sure you have PHPUnit 3.5.0 and up installed, and just run the following in the project root,

phpunit

• Written and developed by Stephen Melrose.
• Original concept by Paul Lemon.