Composr API documentation
Back to top  

Functions

Get code to do an AJAX check of the CAPTCHA.

captcha_ajax_check() : string
package captcha

Returns

stringJavaScript code.

Outputs and stores information for a CAPTCHA.

captcha_script() 
package captcha

Checks a CAPTCHA.

check_captcha(string $code_entered, boolean $regenerate_on_error = true) : boolean
package captcha

Parameters

$code_entered

string

CAPTCHA entered.

$regenerate_on_error

boolean

Whether to possibly regenerate upon error.

Returns

booleanWhether it is valid for the current session.

Calling this assumes captcha was needed. Checks that it was done correctly.

enforce_captcha(boolean $regenerate_on_error = true) 
package captcha

Parameters

$regenerate_on_error

boolean

Whether to possibly regenerate upon error.

Get a captcha (aka security code) form field.

form_input_captcha() : \Tempcode
package captcha

Returns

\TempcodeThe field

Generate a CAPTCHA image.

generate_captcha() 
package captcha

Find whether captcha (the security image) should be used if preferred (making this call assumes it is preferred).

use_captcha() : boolean
package captcha

Returns

booleanWhether captcha is used