function confirm_form

You are here

7 system.module confirm_form($form, $question, $path, $description = NULL, $yes = NULL, $no = NULL, $name = 'confirm')
4.7 system.module confirm_form($form_id, $form, $question, $path, $description = NULL, $yes = NULL, $no = NULL, $name = 'confirm')
5 system.module confirm_form($form, $question, $path, $description = NULL, $yes = NULL, $no = NULL, $name = 'confirm')
6 system.module confirm_form($form, $question, $path, $description = NULL, $yes = NULL, $no = NULL, $name = 'confirm')

Output a confirmation form

This function returns a complete form for confirming an action. A link is offered to go back to the item that is being changed in case the user changes his/her mind.

If the submit handler for this form is invoked, the user successfully confirmed the action. You should never directly inspect $_POST to see if an action was confirmed.

Parameters

$form: Additional elements to inject into the form, for example hidden elements.

$question: The question to ask the user (e.g. "Are you sure you want to delete the block <em>foo</em>?").

$path: The page to go to if the user denies the action. Can be either a drupal path, or an array with the keys 'path', 'query', 'fragment'.

$description: Additional text to display (defaults to "This action cannot be undone.").

$yes: A caption for the button which confirms the action (e.g. "Delete", "Replace", ...).

$no: A caption for the link which denies the action (e.g. "Cancel").

$name: The internal name used to refer to the confirmation item.

Return value

The form.

28 calls to confirm_form()
aggregator_admin_remove_feed in modules/aggregator/aggregator.module
block_box_delete in modules/block/block.module
Menu callback; confirm deletion of custom blocks.
comment_confirm_delete in modules/comment/comment.module
comment_multiple_delete_confirm in modules/comment/comment.module
List the selected comments and verify that the admin really wants to delete them.
contact_admin_delete in modules/contact/contact.module
Category delete page.

... See full list

File

modules/system/system.module, line 2152
Configuration system that lets administrators modify the workings of the site.

Code

function confirm_form($form, $question, $path, $description = NULL, $yes = NULL, $no = NULL, $name = 'confirm') {
  $description = isset($description) ? $description : t('This action cannot be undone.');

  // Prepare cancel link
  $query = $fragment = NULL;
  if (is_array($path)) {
    $query = isset($path['query']) ? $path['query'] : NULL;
    $fragment = isset($path['fragment']) ? $path['fragment'] : NULL;
    $path = isset($path['path']) ? $path['path'] : NULL;
  }
  $cancel = l($no ? $no : t('Cancel'), $path, array(), $query, $fragment);

  drupal_set_title($question);

  $form['#attributes'] = array('class' => 'confirmation');
  $form['description'] = array('#value' => $description);
  $form[$name] = array(
    '#type' => 'hidden',
    '#value' => 1,
  );

  $form['actions'] = array(
    '#prefix' => '<div class="container-inline">',
    '#suffix' => '</div>',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => $yes ? $yes : t('Confirm'),
  );
  $form['actions']['cancel'] = array('#value' => $cancel);
  $form['#base'] = 'confirm_form';
  return $form;
}