reCAPTCHA library for CodeIgniter
Switch branches/tags
Nothing to show
Clone or download
Latest commit 2fdab7e Feb 27, 2017

README.md

CodeIgniter-reCAPTCHA

The FREE anti-abuse service. Easy to add, advanced security, accessible to wide range of users and platforms. This package is compliant with PSR-1 and PSR-2.

What is reCAPTCHA?

reCAPTCHA is a free service that protects your site from spam and abuse. It uses advanced risk analysis engine to tell humans and bots apart. With the new API, a significant number of your valid human users will pass the reCAPTCHA challenge without having to solve a CAPTCHA (See blog for more details). reCAPTCHA comes in the form of a widget that you can easily add to your blog, forum, registration form, etc.

See the details.

Sign up for an API key pair

To use reCAPTCHA, you need to sign up for an API key pair for your site. The key pair consists of a site key and secret. The site key is used to display the widget on your site. The secret authorizes communication between your application backend and the reCAPTCHA server to verify the user's response. The secret needs to be kept safe for security purposes.

Installation

You can install via http://getsparks.org/packages/recaptcha-library/show

$ php tools/spark install -v1.0.2 recaptcha-library

or manual install

$ cp config/recaptcha.php your_application/config/
$ cp libraries/recaptcha.php your_application/libraries/

Usage

Set your site key and secret on config/recaptcha.php file

$config['recaptcha_site_key'] = '';
$config['recaptcha_secret_key'] = '';

Render the reCAPTCHA widget

$this->load->library('recaptcha');
echo $this->recaptcha->getWidget();

output:

<div class="g-recaptcha" data-sitekey="xxxx" data-theme="light" data-type="image" data-callback="" ></div>

change default theme by pass array parameter

echo $this->recaptcha->getWidget(array('data-theme' => 'dark'));

change default type by pass array parameter

echo $this->recaptcha->getWidget(array('data-theme' => 'dark', 'data-type' => 'audio'));

Render Script Tag

$this->load->library('recaptcha');
echo $this->recaptcha->getScriptTag();

output:

<script type="text/javascript" src="https://www.google.com/recaptcha/api.js?render=onload&hl=en" async defer></script>

change render value by pass array parameter

echo $this->recaptcha->getScriptTag(array('render' => 'explicit'));

change default language by pass array parameter

echo $this->recaptcha->getScriptTag(array('render' => 'explicit', 'hl' => 'zh-TW'));

Verify Response

Calls the reCAPTCHA siteverify API to verify whether the user passes g-recaptcha-response POST parameter.

$recaptcha = $this->input->post('g-recaptcha-response');
$response = $this->recaptcha->verifyResponse($recaptcha);

check success or fail

if (isset($response['success']) and $response['success'] === true) {
    echo "You got it!";
}

see the example controller and view

Author

Bo-Yi Wu @appleboy