timnarr/kirby-obfuscate-email

This plugin provides field methods to obfuscate email addresses.

Maintainers

Details

github.com/timnarr/kirby-obfuscate-email

Homepage

Source

Issues

Installs: 341

Dependents: 0

Suggesters: 0

Security: 0

Stars: 18

Watchers: 1

Forks: 0

Open Issues: 0

Type:kirby-plugin

0.1.0 2024-02-15 10:34 UTC

Requires

Requires (Dev)

MIT 490c657ec0ab60e5c283469a207f888ae814bb83

This package is auto-updated.

Last update: 2025-03-15 13:02:48 UTC

README

This plugin provides e-mail obfuscation via field-methods to prevent spam bots from harvesting e-mail addresses from your website.

Credits

First things first - I basically copied this plugin code from seehat's post in the Kirby forum. Many thanks to him.

Installation via Composer

composer require timnarr/kirby-obfuscate-email

Usage

Use the obfuscateEmail() field method if you just want to obfuscate an single e-mail value from a field. Example: $page->emailField()->obfuscateEmail().

If you want to obfuscate multiple e-mails in a text field you can use the obfuscateEmails() method. This method uses regex to find all e-mails and obfuscate them. Example: $page->myTextField()->obfuscateEmails().

Options

Option Default Type Description
regex /[A-Z0-9\._%+-]+(@)[A-Z0-9\.-]+(\.)[a-z]{2,}/i string Regular expression, used to find e-mails in text. Change to custom pattern if needed.

License

MIT License Copyright © 2024-present Tim Narr