Skip to main content

Introduction

plone.formwidget.recaptcha is a z3c.form ReCaptcha widget for use with Plone.

It is a z3c.form re-implementation of the collective.recaptcha package original written by David Glick.

Buildout Installation

Add the following code to your buildout.cfg to install plone.formwidget.recaptcha:

[buildout]
...

[instance]
...
eggs =
    ...
    plone.formwidget.recaptcha
    ...

ReCaptcha setup

There is a control panel at http://path/to/site/@@recaptcha-settings to configure the Addon. Google provides a set of test keys, that can be used to try out the recaptcha form and documentation at https://developers.google.com/recaptcha/docs/faq.

Site key: 6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI

Secret key: 6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe

To actually use the service, you must obtain a site key and secret key from developers.google.com/recaptcha

Usage

The ReCaptcha validator will be enabled by default in all of your forms that use the ReCaptcha Field and Widget.

See the demo folder inside the distribution for an example usage.

Supermodel

You can add a captcha field in an XML model by adding something like this:

<field name="captcha" type="plone.formwidget.recaptcha.ReCaptchaWidget">
  <title>Solve Captcha</title>
  <description></description>
</field>

Upgrade to API v3

plone.formwidget.recaptcha 3.* allows to use both v3 and v3 reCaptcha. plone.formwidget.recaptcha 2.* uses V2 of the reCaptcha API. Users upgrading from plone.formwidget.recaptcha 1.* will therefore need to generate new keys as global Keys are not supported in the V2 API.

Source Code

Contributors please read the document Process for Plone core’s development

Sources are at the Plone code repository hosted at Github.

Contributors

Changelog

3.0.0 (2026-02-12)

Breaking changes:

  • Support Plone 6-only @erral Apply plone/meta @erral (#40)

New features:

  • Add an adapter to show the control panel in Volto and register translations [erral] (#32)

  • Add new languages Catalan and French [aormazabal] (#35)

  • Adds support for reCAPTCHA v3 @rohnsha0 (#38)

  • Provide a default validator for the recaptcha field @erral

Internal:

  • Update configuration files. [plone devs]

Tests:

  • Move CI from TravisCI to Github Actions [jensens] (#29)

2.3.0 (2021-03-01)

New features:

  • Provide a field to be used from an XML model [frapell] (#24)

  • Subsite support (i.e. collective.lineage) [jensens] (#28)

Bug fixes:

  • Format code according to Plone standards: black, isort, zpretty. (#27)

  • Move CI from TravisCI to Github Actions [jensens] (#29)

  • Do not validate captcha field upon z3c form inline validation. [mathias.leimgruber]

2.2.0 (2019-07-10)

New features:

  • Python 3 compatibility [staeff, petschki] (#19)

2.1.0 (2019-02-20)

  • Update TravisCI Setup and test with Plone 5.1 and 5.2 on Python 2.7. Also test on Python 3.6+3.7 (allowed to fail, and fails for now). [jensens]

  • Remove obsolete action icons configuration. [thet]

  • update controlpanel text [lucid-0]

  • Remove obsolete recaptcha_ajax.js - all scripts are integrated via the norecaptcha package. Add upgrade step for that. [thet]

2.0.0 (2018-09-05)

  • Add a dummy widget display view which renders empty. A widget needs a display view, otherwise form result rendering may fail. [thet]

2.0a3 (2016-12-21)

2.0a2 (2015-06-17)

  • Fix: problem with MANIFEST.in and old package structure made 2.0a1 a brown bag release. All non-python files (i.e. zcml) were missing. [jensens]

2.0a1 (2015-06-17)

  • some pep8/plone conventions code style cleanup. [jensens]

  • recaptcha API 2 (aka norecaptcha) [mamico]

1.0b3 - 2010-11-18

  • Register browser components for a product browser layer so they don’t leak to sites without this product installed. Run the upgrade step if upgrading on a site that already has this product installed. [davisagli]

  • Move to plone.app.discussion-captcha feature declaration to meta.zcml. [timo]

  • Adapt recaptcha view instead of captcha view for validation. [ramon]

1.0b2 - 2010-06-02

  • Updated package metadata and marked this as a Plone add-on. [timo]

  • Declare that plone.formwidget.captcha provides a Captcha field that can be used by plone.app.discussion to add a Captcha field to comment forms. [timo]

1.0b1 - 2009-12-07

  • z3c.autoinclude.plugin added [timo]

1.0a1 - 2009-08-28

  • Initial release [timo]

Release files for plone.formwidget.recaptcha 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for plone.formwidget.recaptcha 3.0.0
File Size Uploaded
plone_formwidget_recaptcha-3.0.0.tar.gz 31.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for plone.formwidget.recaptcha 3.0.0
File Interpreter ABI Platform
plone_formwidget_recaptcha-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size:74.3 kB

Release files / plone_formwidget_recaptcha-3.0.0.tar.gz

Download URL plone_formwidget_recaptcha-3.0.0.tar.gz
Size 31.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a64d780bf66201b3bca4d989cfee3a6b0dc64e2c6e555ce301f2868eb9b0449b
BLAKE2b-256 checksum
How to use checksums
62047405cfd0aca45dadb64a071b776273c62d1a0829b857e213ce3730d2ab74
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.3

Release files / plone_formwidget_recaptcha-3.0.0-py3-none-any.whl

Download URL plone_formwidget_recaptcha-3.0.0-py3-none-any.whl
Size 42.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b2578c62a2bd737a63665cebe98f4d0dde940a868478ff062e61fce39a42be90
BLAKE2b-256 checksum
How to use checksums
38d435794737d07e6805d6d5c9817a0869783b6e1ea0a387cf79665e0669f1eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page