LAM - Profanity Filter

[admin]

This product will mask out rude words on your forum, but with an option that allows the filter to be turned off by the user.

The filter works on all forum posts, threads, titles, search results and emails. There is also a BLOGs version of this product which I've extended to also filter the built-in blogs, comments, latest bits and titles. Blog support is not 100% complete yet. There are some places where no suitable hooks exist for the filter to work; blog search results being an example. Hopefully these will be fixed as and when more hooks become available. (I'd rather wait for the hooks then start giving instructions on hacking the files)


Installation

Download the required .xml file
product-LAM_product-LAM_ProfanityFilter.xml or product-LAM_ProfanityFilterBLOG.xml
Install the product
AdminCP -> Plugins & Products -> Add/Import Product -> Import Product
Create the required User Profile Field
A picture speak a thousand words....
http://img.photo.zing.vn/file_uploads/gallery/1024x768/2010/11/03/04/53971288777160.jpg
...but here are the words as well!


Title = Profanity Filter
Description = The profanity filter will mask out mature language from forum posts
Profile Field Category = (Uncategorized)
Options = {Copy and paste in the two lines below}
Turn On
Turn Off
Set Default = Yes
Display Order = You Select this (dependant on how many you already have)
Field Required = No
Field Editable by User = Yes
Private Field = Yes
Field Searchable on Members List = No
Show on Members List = No

Optional Input
--------------

Allow user to input their own value for this option = No
Max length of allowed user input = 100
Field Length = 25
Regular Expression = {Leave this Blank}


Display Page
------------

Which page displays this option? = Edit Profile

Make a note of the FieldID at the top of the page because you will need to use it to configure this product.

Press Save

Configure the product


Configuration

You need to configure the product to specify the Profile Field ID to use (the one created during installation). If you want to change the "Turn On" "Turn Off" labels in the profile field (e.g. for translations) then you need to change the default "Turned Off" Selection option. This product works on the basis that the filter is always on unless the user chooses to turn it off. Therefore it needs to know what to look for to determine the user has turned it off. Next is the filter mask. This is the replacement for any words which have been filtered. And finally is the list of words to filter. I've masked them out in the picture below just in case vB.org get upset. http://www.vbulletin.org/forum/images/smilies/smile.gif

http://img.photo.zing.vn/file_uploads/gallery/1024x768/2010/11/03/04/18611288777206.png

Each user can then turn the filter off in their user cp...

http://img.photo.zing.vn/file_uploads/gallery/1024x768/2010/11/03/04/22301288777230.png

Example

A user who has the profanity filter turned off can create and view posts without any alterations being made to them. For users with the profanity filter turned on this product should mask out the configured words where ever they may appear on your forum.

Here are some examples of the filter at work...

http://img.photo.zing.vn/file_uploads/gallery/1024x768/2010/11/03/04/97791288777254.pnghttp://img.photo.zing.vn/file_uploads/gallery/1024x768/2010/11/03/04/10491288777266.pnghttp://img.photo.zing.vn/file_uploads/gallery/1024x768/2010/11/03/04/73801288777277.pnghttp://img.photo.zing.vn/file_uploads/gallery/1024x768/2010/11/03/04/39791288777290.png

Known Issues

Blog search results are not filtered
Latest blog/comments AJAX results are not filtered

Version History

4.0.8.1 - Fix to prevent over filtering if a trailing comma is put in the filtered words list (2010/11/03)
4.0.8.0 - Initial release (2010/11/02)