phpBB

Development Wiki

Difference between revisions of "Function.add form key"

From phpBB Development Wiki

(Description)
(Description)
Line 3: Line 3:
 
==Description==
 
==Description==
 
#<pre>void add_form_key (String $form_name)</pre>
 
#<pre>void add_form_key (String $form_name)</pre>
This functions adds a secret token to any form, this token can be checked after submission with the [[Check_form_key|check_form_key]] function to ensure that the received data is the same as the submitted.
+
This functions adds a secret token to any form, a token which should be checked after submission with the [[Check_form_key|check_form_key]] function to ensure that the received data is the same as the submitted.
  
 
: <div class="toc" style="padding:10px;">'''Note''': This function expects that the {S_FORM_TOKEN} template variable is present in the template file being used!</div>
 
: <div class="toc" style="padding:10px;">'''Note''': This function expects that the {S_FORM_TOKEN} template variable is present in the template file being used!</div>

Revision as of 19:45, 9 March 2009

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, a token which should 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 file being used!

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