https://github.com/globalia/craft-recaptcha-v3

A Craft CMS 2 reCAPTCHA v3 plugin.
https://github.com/globalia/craft-recaptcha-v3

Last synced: 5 months ago
JSON representation

A Craft CMS 2 reCAPTCHA v3 plugin.

• Host: GitHub
• URL: https://github.com/globalia/craft-recaptcha-v3
• Owner: globalia
• Created: 2020-05-20T20:05:14.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-10T15:35:27.000Z (over 2 years ago)
• Last Synced: 2024-01-10T17:56:00.453Z (over 2 years ago)
• Language: PHP
• Size: 18.6 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# reCAPTCHA v3

Adds reCAPTCHA capability to Craft CMS 2 forms.

## How to use

### There is a little example snippet

Add this code in your \ :

```

{% if craft.plugins.getPlugin('recaptchaV3', true) and craft.recaptchaV3.hasRecaptchaKeys %}

    

{% endif %}

```

The `data-action="contact"` attribute will be the action sent to reCAPTCHA. It's useful to know 

from which form the data is coming from. In this case, this is the Contact form.

In your \ :

** Remove `and renderReCaptcha | default` if you want to load reCAPTCHA on all pages)

```

{% if craft.plugins.getPlugin('recaptchaV3', true) and renderReCaptcha | default and craft.recaptchaV3.hasRecaptchaKeys %}

    {% set reCaptchaSiteKey = craft.recaptchaV3.getRecaptchaSiteKey %}

    {% if reCaptchaSiteKey %}

        

        

            document.addEventListener('DOMContentLoaded', function(event) {

                var recaptchaResponses = document.querySelectorAll('input[name="g-recaptcha-response"]');

                for (var index = 0; index < recaptchaResponses.length; index++) {

                    var form = recaptchaResponses[index].closest('form');

                    if (form !== null) {

                        form.addEventListener('submit', getRecaptchaToken);

                    }

                }

            });

            function getRecaptchaToken(event) {

                event.preventDefault();

                var form = event.target;

                if (form !== null) {

                    var recaptchaResponse = form.querySelector('input[name="g-recaptcha-response"]');

                    var recaptchaAction = recaptchaResponse.dataset.action !== undefined ? recaptchaResponse.dataset.action : 'submit';

                    if (recaptchaResponse !== null) {

                        grecaptcha.ready(function() {

                            grecaptcha.execute('{{ reCaptchaSiteKey }}', { action: recaptchaAction }).then(function(token) {

                                recaptchaResponse.value = token;

                                form.submit();

                            });

                        });

                    }

                }

            }

        

    {% endif %}

{% endif %}

```

If you use Formerly, here is code example to use.


In craft/plugins/recaptchav3/RecaptchaV3Plugin.php

```

if (craft()->plugins->getPlugin('formerly', true)) {

    if ($reCaptchaSecretKey = craft()->recaptchaV3->getSecretKey()) {

        craft()->on('formerly_submissions.onBeforePost', function (Event $event) {

            $submission = $event->params['submission'];

            $form = craft()->formerly_forms->getFormById($submission->formId);

            if ($form->handle == 'contactUs' && ! empty(craft()->recaptchaV3->getSecretKey())) {

                if (! craft()->recaptchaV3->verify(craft()->request->getPost('g-recaptcha-response', null))) {

                    $error = Craft::t('recaptcha.error.message');

                    $submission->addError('recaptcha', $error);

                }

            }

        });

    }

}

```

and in your template :

```

Between {% extends %} and {% block content %}

{% set renderReCaptcha = true %}

In {% block content %} :

{% if submission is defined and submission.getAllErrors() | length %}

    


        {% for error in submission.getAllErrors() %}

            
{{ error }}

        {% endfor %}

    

{% endif %}

```


For a&m forms


In craft/plugins/recaptchav3/RecaptchaV3Plugin.php

```

if (craft()->plugins->getPlugin('amforms', true)) {

    if ($reCaptchaSecretKey = craft()->recaptchaV3->getSecretKey()) {

        craft()->on('amForms_submissions.onBeforeSaveSubmission', function (Event $event) {

            $submission = $event->params['submission'];

            $form = $submission->getAttribute('form');

            if (in_array($form->handle, ['contact-en', 'contact-fr']) && ! empty(craft()->recaptchaV3->getSecretKey())) {

                if (! craft()->recaptchaV3->verify(craft()->request->getPost('g-recaptcha-response', null))) {

                    $event->performAction = false;

                    $error = Craft::t('recaptcha.error.message');

                    $submission->addError('recaptcha', $error);

                }

            }

        });

    }

}

```

## In your template

If you want to render reCAPTCHA only in one (or more) specific template, you can set 

a variable between {% extends %} and {% block content %}

```

{% set renderReCaptcha = true %}

```

You can import macro in  the template directly :

```

{% macro errorList(errors) %}

    {% if errors %}

        


            {% for error in errors %}

                
{{ error }}

            {% endfor %}

        

    {% endif %}

{% endmacro %}

{% from _self import errorList %}

```


or create a file with all your macros and import it, as described below.

Create a file _macros.twig in templates folder and paste this code :

```

{% macro errorList(errors) %}

    {% if errors %}

        


            {% for error in errors %}

                
{{ error }}

            {% endfor %}

        

    {% endif %}

{% endmacro %}

```


In your template :

```

{% import "_macros" as macros %}

```

In {% block content %}, copy this code where you want the reCAPTCHA error to be outputted :

```

{% if formHandle is defined %}

    {{ errorList(formHandle.getErrors('recaptcha')) }}

{% endif %}

```

or if your macro is in a file and has been imported :

```

{% if formHandle is defined %}

    {{ macros.errorList(formHandle.getErrors('recaptcha')) }}

{% endif %}

```