ExpressionEngine® User Guide

Legacy Documentation

You are using the documentation for version 4.3.8. Go here for the latest version.

Functions Library Extension Hooks

create_captcha_start

create_captcha_start($old_word)

Allows rewrite of how CAPTCHAs are created.

How it’s called:

$edata = ee()->extensions->call('create_captcha_start', $old_word);
if (ee()->extensions->end_script === TRUE) return $edata;
Parameters:
  • $old_word (string) – Normally empty, but it will create a CAPTCHA with that word if set
Return type:

Void

New in version 1.4.0.

form_declaration_modify_data

form_declaration_modify_data($data)

Modify the $data parameters before they are processed by the user side form creator.

How it’s called:

$data = $this->extensions->call('form_declaration_modify_data', $data);
Parameters:
  • $data (array) – Array of arguments sent to the form_declaration() method
Returns:

Manipulated array to pass to form_declaration()

Return type:

Array

New in version 1.4.2.

form_declaration_return

form_declaration_return($data)

Take control of the form_declaration function to create form tags the way you want.

How it’s called:

$form = $this->extensions->call('form_declaration_return', $data);
if ($this->extensions->end_script === TRUE) return $form;
Parameters:
  • $data (array) – Array of arguments sent to the function for creating the form tag
Returns:

String containing the opening form tag, must set end_script to FALSE for this to work

Return type:

String

New in version 1.4.2.