Download the PHP package imliamxo/shush without Composer

On this page you can find all versions of the php package imliamxo/shush. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of imliamxo/shush

Informations about the package shush

🀫 Shush

A configurable, multi-language profanity filter for Laravel with severity tiers, per-language normalisers, and evasion-resistant detection.

Catches shit, sh!t, sh1t, $h!t, shiiit, sshit, s.h.i.t β€” and everything in between. Ships with extensive English and Polish dictionaries out of the box.

Installation

Quick Start

Strictness Levels

Words are categorised into three severity tiers. The strictness setting controls which tiers are active:

Strictness Tiers caught Use case
relaxed severe only Catch slurs & hate speech, allow swearing
normal severe + moderate Block strong profanity (default)
strict severe + moderate + mild Family-friendly, zero tolerance

Evasion Detection

Each language has a dedicated normaliser that catches evasion techniques:

Technique Example Caught?
Leet-speak symbols sh!t, $h1t, b@stard βœ…
Number substitution sh1t, a55, f4g βœ…
Repeated characters shiiit, fuuuck, sshit βœ…
Separator tricks s.h.i.t, f-u-c-k, s h i t βœ…
Mixed evasion $h!iit, f.u.c.k βœ…
Unicode homoglyphs Cyrillic Π°/Π΅/ΠΎ lookalikes βœ…
Zero-width characters Hidden unicode between letters βœ…
Diacritic stripping Polish gΓ³wno β†’ gowno βœ…
Diacritic substitution Δ… β†’ a, Ε‚ β†’ l βœ…

Per-Language Normalisers

Each language can have its own normaliser that understands its character set and evasion patterns:

Adding a Custom Normaliser

Register it in config/shush.php:

Or at runtime:

Built-in False-Positive Whitelist

Shush ships with an extensive whitelist of 200+ words that contain profanity substrings but aren't profane. This prevents false positives on words like:

Place names: Scunthorpe, Penistone, Cockermouth, Middlesex, Sussex, Essex, Effingham

Common words: class, classic, assess, assessment, asset, assign, assist, associate, assume, assembly, assault, bass, brass, glass, grass, mass, pass, passport, passion, passive, embarrass, harassment

Compound words: cocktail, cockatoo, cockerel, cockpit, peacock, Hitchcock, shuttlecock

Other: therapist, grapefruit, skyscraper, dictionary, predict, constitution, document, accumulate, circumstance, Mississippi

Polish false positives are also covered: kurier, kurort, kurczak, duplikat.

Adding Languages

Create a folder in resources/shush/dictionaries/:

Each file returns an array keyed by tier:

Flat arrays (no tier keys) are treated as moderate. All .php files in a language folder are merged.

Enable in config:

Modes

Censor (default)

Block

Middleware

Validation Rule

Runtime API

Configuration Reference

Key Default Description
mode censor censor or block
strictness normal relaxed, normal, or strict
normalise true Enable evasion detection
normalisers [] Custom normaliser class map ['de' => MyClass::class]
mask * Mask character for censor mode
mask_behaviour character character or full
mask_replacement *** Replacement when mask_behaviour is full
languages ['en'] Dictionary folders to load
extra_words [] Additional words (string or {word, tier, language})
whitelist [] Extra words to never flag (merged with built-in whitelist)
middleware_fields [] Request fields to scan (empty = all strings)

Architecture

License

MIT

All versions of shush with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
illuminate/support Version ^10.0|^11.0|^12.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package imliamxo/shush contains the following files

Loading the files please wait ...