README

Stop more bots. Start protecting user privacy. This module adds hCaptcha to forms in OXID eShop.

Requirements

OXID: ^6
PHP: ^7.0 || ^8.0

Installation

To install the module run the following command from the root directory of your OXID installation.

composer require tremendo/hcaptcha

Activation

After installing the module, you need to activate it, either via OXID eShop admin or CLI.

./bin/oe-console oe:module:activate tremendo_hcaptcha

Configuration

Basic settings

Site key and secret

Visit hcaptcha.com and register for free. You will recieve a site key and a secret. Enter both in the modules's settings page.

Language

If you want to use a specific language for the widget, you can enter a language code here. Leave this field empty to auto dectect the user's language.

Google reCaptcha compatibility

Whether or not to insert window.grecaptcha compatibility hook.

Appearance

Theme

Choose the widget's theme (light or dark).

Display Mode

Choose the widget's display mode (normal, compact or invisible) here.

If you use the invisible mode hCaptcha client/server interactions occur in the background, and the user will only be presented with a hCaptcha challenge if that user meets challenge criteria.

Links to hCaptcha's privacy policy and TOS

Check this option to include links to hCaptcha's privacy policy and terms of service if the widget is in invisible mode. Recommended.

Callbacks

If you want to use your own event handlers for the widget, you can activate them here.

Before you do this please make a copy of the file src/js/hcaptcha_callbacks.dist.js and rename it to hcaptchta_callbacks.js so the module can find it and future updates will not override your changes.

Content-Security-Policy Settings

If you use CSP add https://hcaptcha.com and https://*.hcaptcha.com to script-src, frame-src, style-src and connect-src.

License

This module is licensed under the MIT License.

tremendo / oxid-hcaptcha

Maintainers

Details