phpBB

Development Wiki

Difference between revisions of "Function.add form key"

From phpBB Development Wiki

(New page: add_form_key -- Add a secret token to the form. ==Description== #<pre>void add_form_key (String $form_name)</pre> This functions adds a secret token to any form, this token can be checked...)
 
m (Example #2)
Line 19: Line 19:
 
===Example #1 Add a form token===
 
===Example #1 Add a form token===
 
To add the form token you only have to call the function.
 
To add the form token you only have to call the function.
<php>add_from_key('Formname');</php>
+
<php>$form_key = 'my_form';
 +
add_from_key($form_key);</php>
 +
 
 +
===Example #2 Usage with check_form_key===
 +
Basic add_form_key usage with the [[check_form_key]] function.
 +
<php>$form_key = 'my_form';
 +
add_form_key($form_key);
 +
 
 +
if (!check_form_key($form_key))
 +
{
 +
    $errors[] = $user->lang['FORM_INVALID'];
 +
}</php>
  
 
==See Also==
 
==See Also==

Revision as of 22:07, 23 September 2008

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_from_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