README

A List of Dirty, Naughty, Obscene, and Otherwise Bad Words to use in PHP via Composer.

Obvious warning: These lists contain material that many will find offensive. (But that's the point!)

Before you start

If you think that implementing an automatic filter of bad words is a good idea, you should really check these articles first:

• Obscenity Filters: Bad Idea, or Incredibly Intercoursing Bad Idea?
• Scunthorpe problem

To sum it up, this library by no way should be used as a 100% way to get rid of obscene language in your application. People will always find out ways to bypass your filters. If you need to handle bad words, you need manual control. Tools like this one are meant to assist human moderation, not to replace it.

Use cases, where this library might be of use:

1. Requesting an approval from a moderator after user input validation when potentially bad words are found.
2. Refuse user input only when an exact match of a bad word is found.
   (This is easily bypassed when a bad word is given one more arbitrary letter, just so the exact match won't succeed.)

Installation

composer require vasart/naughty-words

Usage

Receiving a plain list of naughty words:

use VasArt\NaughtyWords\NaughtyWords;

$naughtyWordsEn = NaughtyWords::getForLanguage('en');

The string 'en' inside getForLanguage() call here is the name of the file with bad words for the language of choice. See the list of available languages in Languages section.

Using built-in validator:

use VasArt\NaughtyWords\Validator;

$text = 'some user input with potentially bad words';

$naughtyWordsValidator = new Validator( [ 'en', 'ru' ] );
$naughtyWords = $naughtyWordsValidator->findNaughtyWords( $text );

var_export($naughtyWords); // [ 'en' => 'word', 'ru' => false ]

For examining how does built-in validator work exactly you should check:

• test cases inside ValidatorTest class;
• regular expression that is built inside WordsList class.

Languages

Other installation options

If you need to use bad words inside an npm project, you can install the word list using the naughty-words package.

License

The code, configuration and project description files are licensed under GNU GPL 3.0, see LICENSE.

The list of words is licensed under a Creative Commons Attribution 4.0 International License, see LICENSE.words. © 2012–2020 Shutterstock, Inc.

More naughty words

• expletives
• google-profanity-words
• encycloDB / Dirty Words