phpBB

Development Wiki

Function.add form key

From phpBB Development Wiki

Revision as of 07:20, 20 February 2009 by 3di (Talk | contribs)

add_form_key -- Add a secret token to the form.

Description

  1. void add_form_key (String $form_name)

This functions adds a secret token to any form, this token can be checked after submission with the check_form_key function to ensure that the received data is the same as the submitted.

Note: This function expects that the {S_FORM_TOKEN} template variable is present in the template that is used for the selected page!

Parameters

Parameter Usage
form_name The name of the form; has to match the name used in check_form_key, otherwise no restrictions apply.

Examples

Example #1 Add a form token

To add the form token you only have to call the function.

$form_key 'my_form';
add_form_key($form_key);

Example #2 Usage with check_form_key

Basic add_form_key usage with the check_form_key function.

$form_key 'my_form';
add_form_key($form_key);

if (!
check_form_key($form_key))
{
    
$errors[] = $user->lang['FORM_INVALID'];
}

See Also

check_form_key