View source

From phpBB Development Wiki

for Confirm box

You do not have permission to edit this page, for the following reason:

The action you have requested is limited to users in the group: Users.

You can view and copy the source of this page:

confirm_box –– Present a confirmation screen which offers the user a Yes or No option. A confirmation should be used before committing any sensitive operation.
{{stub}}

==Description==
#<pre> bool confirm_box ( $check [, $title [, $hidden [, $html_body [, $u_action ]]]] )</pre>
The confirm boxes are phpBB3's system to secure critical actions against CSRF attacks and unintentional triggering. The system is quite simple: the function can be called in check mode, where it will check the presence of a one-time confirmation string passed as request parameter or in display mode, where it will display the confirm box.<br>

==Parameters==
{|border="1" cellspacing="0" cellpadding="3"
! Parameter
! Required
! Default
! Usage
|-
| '''check'''
| Yes
| bool
| True for checking if confirmed (without any additional parameters) and false for displaying the confirm box
|-
| '''title'''
| No
| <nowiki>''</nowiki>
| string - Title/Message used for confirm box. Specified as a language key used to explain to the user what action they are confirming. message text is _CONFIRM appended to title. If title cannot be found in user->lang a default one is displayed If title_CONFIRM cannot be found in user->lang the text given is used.
|-
| '''hidden'''
| No
| <nowiki>''</nowiki>
| string - Hidden variables (in HTML) for passing within the script.
|-
| '''html_body'''
| No
| 'confirm_body.html'
| Template used for confirm box
|-
| '''u_action'''
| No
| <nowiki>''</nowiki>
| string - Custom form action
|}<br>

Generally, you will need to supply the first three parameters, while the remaining two are usually fine left default. The second parameter should be a language key used to explain to the user what the confirm box is about. The third parameter, $hidden, should hold html for hidden fields containing all (user-)submitted values needed to get the current script to exactly the state where it is when calling the function.<br>

==Return Values==
Returns true if the user confirmed the operation, false if the user cancelled or an error occurred resulting in the form being cancelled.

==Examples==
===Example #1 Generic usage===
<php>if ($submit)
{
    // check mode
    if (confirm_box(true))
    {
        submit($my_message);
    }
    else
    {
        $s_hidden_fields = build_hidden_fields(array(
            'submit'    => true,
            'my_mesage' => $my_message,
            )
        );

        //display mode
        confirm_box(false, 'SAMPLE_LANG_KEY', $s_hidden_fields);
    }
}</php><br>

==Notes==
: <div class="toc" style="padding:10px;">'''Note''': When using [[Confirm_box|confirm_box()]], the [[Add_form_key|add_form_key()]] and [[Check_form_key|check_form_key()]] functions are not needed (for CSRF protection).</div>

==See Also==
* [[build_hidden_fields]]
* [[add_form_key]]
* [[check_form_key]]
<br><br>

[[Category:Functions]]

[[ja:Confirm_box]]

Templates used on this page:

Template:Stub (view source)

Return to Confirm box.

Retrieved from "http://wiki.phpbb.com/Confirm_box"