Simple Swear Filter In PHP

30th September 2008 - 3 minutes read time

Use the following function to filter out words from user input. It works by having a pre-set array of words that are to be excluded, this array is then looped through and each item is used to replace any instances of that word within the text. The regular expression uses the \b character class, which stands for any word boundary. This way you don't get the middle of words being filtered out when they are not meant to be.

By using the e of the preg_replace function it is possible to run PHP functions within the output. In this case we count the number of characters found in the replace and use this to create a string of stars (*) of equal length.

function filterwords($text){
 $filterWords = array('gosh', 'darn', 'poo');
 $filterCount = sizeof($filterWords);
 for($i=0; $i < $filterCount; $i++) {
  $text = preg_replace('/\b'.$filterWords[$i].'\b/ie',"str_repeat('*',strlen('$0'))",$text);
 }
 return $text;
}

When the following text is run through this function.

echo filterwords('Darn, I have a mild form of tourettes, poo!');

It produces the following result.

****, I have a mild form of tourettes, ***!

Update: Because a few people have asked I have updated this example using preg_replace_callback().

function filterwords($text){
 $filterWords = array('gosh', 'darn', 'poo');
 $filterCount = sizeof($filterWords);
 for ($i = 0; $i < $filterCount; $i++) {
  $text = preg_replace_callback('/\b' . $filterWords[$i] . '\b/i', function($matches){return str_repeat('*', strlen($matches[0]));}, $text);
 }
 return $text;
}

 

PHP
preg_replace
preg_replace_callback

Comments

True, although the solution in this post is completely free, whereas the WebPurify seems expensive for a very simple (and not all that important) web service.
Philip Norton

Submitted by philipnorton42 on Tue, 07/06/2010 - 08:55

Permalink

Hey, really nice script, I can tell you've taken your time on it.

 

I was dealing with a word dictionary called badwords.txt I found on Google Code which had some words in like 's***'. The played havok with your script until I escaped the charachters:

 

$text = preg_replace('/\b'.preg_quote($filterWords[$i]).'\b/ie',"str_repeat('*',strlen('$0'))",$text);

 

I agree, WebPurify is a step too far.

Submitted by Michael Rich on Mon, 12/05/2011 - 03:04

Permalink
Hey Philip this is the only script that has worked as advertized! Thanks for that. Now I have to sit back and work out how and why it works :)

Submitted by steve17 on Fri, 04/25/2014 - 12:12

Permalink
How would I just drop the swear word from the array instead of replacing it with asterisks?

Submitted by Jim on Tue, 06/07/2016 - 17:56

Permalink
Quickest is to replace $text = preg_replace('/\b'.$filterWords[$i].'\b/ie',"str_repeat('*',strlen('$0'))",$text); with $text = preg_replace('/\b'.$filterWords[$i].'\b/ie',"str_repeat('',strlen('$0'))",$text); (removed the *)

Submitted by hashbanganon on Sun, 03/05/2017 - 08:28

Permalink
anyone managed to mod this code using preg_replace_callback ?

Submitted by mike on Thu, 03/15/2018 - 21:07

Permalink

anyone get this to work with preg_replace_callback for php 7?

Submitted by nick on Thu, 04/16/2020 - 20:27

Permalink

Add new comment

The content of this field is kept private and will not be shown publicly.
CAPTCHA
2 + 1 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.
This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.

Related Content

Creating An Authentication System With PHP and MariaDB

15th October 2023

Using frameworks to handle the authentication of your PHP application is perfectly fine to do, and normally encouraged. They abstract away all of the complexity of managing users and sessions that need to work in order to allow your application to function.

Read more

Creating Sparklines In PHP

17th September 2023

A sparkline is a very small line graph that is intended to convey some simple information, usually in terms of a numeric value over time. They tend to lack axes or other labels and are added to information readouts in order to expand on numbers in order to give them more context.

Read more

PHP:CSI - To Switch, Or Not To Switch?

11th September 2022

I was writing unit tests for a API mapping function recently and came across this interesting issue. The code I was writing tests for was in a legacy codebase that I was making changes to, and it made sense to have some unit tests in there before I started work to ensure everything worked before and after.

Read more