form.inc 80.1 KB
Newer Older
1
<?php
2 3
// $Id$

4 5 6
/**
 * @defgroup form Form generation
 * @{
7
 * Functions to enable the processing and display of HTML forms.
8
 *
9 10 11 12 13 14 15
 * Drupal uses these functions to achieve consistency in its form processing and
 * presentation, while simplifying code and reducing the amount of HTML that
 * must be explicitly generated by modules.
 *
 * The drupal_get_form() function handles retrieving, processing, and
 * displaying a rendered HTML form for modules automatically. For example:
 *
16
 * // Display the user registration form.
17 18 19
 * $output = drupal_get_form('user_register');
 *
 * Forms can also be built and submitted programmatically without any user input
20
 * using the drupal_execute() function.
21 22
 *
 * For information on the format of the structured arrays used to define forms,
23 24 25
 * and more detailed explanations of the Form API workflow, see the
 * @link http://api.drupal.org/api/HEAD/file/developer/topics/forms_api_reference.html reference @endlink
 * and the @link http://api.drupal.org/api/HEAD/file/developer/topics/forms_api.html quickstart guide. @endlink
26 27 28
 */

/**
29 30 31
 * Retrieves a form from a constructor function, or from the cache if
 * the form was built in a previous page-load. The form is then passesed
 * on for processing, after and rendered for display if necessary.
32 33
 *
 * @param $form_id
34 35 36 37
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
38
 *   different $form_id values to the proper form constructor function. Examples
39 40
 *   may be found in node_forms(), search_forms(), and user_forms().
 * @param ...
41
 *   Any additional arguments needed by the form constructor function.
42 43 44 45
 * @return
 *   The rendered form.
 */
function drupal_get_form($form_id) {
46 47 48 49 50 51 52 53 54 55
  $form_state = array('storage' => NULL, 'submitted' => FALSE);

  $args = func_get_args();

  if (isset($_SESSION['batch_form_state'])) {
    // We've been redirected here after a batch processing : the form has
    // already been processed, so we grab the post-process $form_state value
    // and move on to form display. See _batch_finished() function.
    $form_state = $_SESSION['batch_form_state'];
    unset($_SESSION['batch_form_state']);
56 57
  }
  else {
58 59 60 61 62 63
    // If the incoming $_POST contains a form_build_id, we'll check the
    // cache for a copy of the form in question. If it's there, we don't
    // have to rebuild the form to proceed. In addition, if there is stored
    // form_state data from a previous step, we'll retrieve it so it can
    // be passed on to the form processing code.
    if (isset($_POST['form_id']) && $_POST['form_id'] == $form_id && !empty($_POST['form_build_id'])) {
64
      $form = form_get_cache($_POST['form_build_id'], $form_state);
65 66
    }

67 68 69 70
    // If the previous bit of code didn't result in a populated $form
    // object, we're hitting the form for the first time and we need
    // to build it from scratch.
    if (!isset($form)) {
71
      $form_state['post'] = $_POST;
72 73 74 75 76
      // Use a copy of the function's arguments for manipulation
      $args_temp = $args;
      array_shift($args_temp);
      array_unshift($args_temp, $form_state);
      array_unshift($args_temp, $form_id);
77

78
      $form = call_user_func_array('drupal_retrieve_form', $args_temp);
79
      $form_build_id = 'form-'. md5(mt_rand());
80
      $form['#build_id'] = $form_build_id;
81 82
      drupal_prepare_form($form_id, $form, $form_state);
      if (!empty($form['#cache'])) {
83 84 85
        // By not sending the form state, we avoid storing the storage which
        // won't have been touched yet.
        form_set_cache($form_build_id, $form, NULL);
86
      }
87
      unset($form_state['post']);
88
    }
89
    $form['#post'] = $_POST;
90

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    // Now that we know we have a form, we'll process it (validating,
    // submitting, and handling the results returned by its submission
    // handlers. Submit handlers accumulate data in the form_state by
    // altering the $form_state variable, which is passed into them by
    // reference.
    drupal_process_form($form_id, $form, $form_state);
  }

  // Most simple, single-step forms will be finished by this point --
  // drupal_process_form() usually redirects to another page (or to
  // a 'fresh' copy of the form) once processing is complete. If one
  // of the form's handlers has set $form_state['redirect'] to FALSE,
  // the form will simply be re-rendered with the values still in its
  // fields.
  //
  // If $form_state['storage'] or $form_state['rebuild'] have been
  // set by any submit or validate handlers, however, we know that
  // we're in a complex multi-part process of some sort and the form's
  // workflow is NOT complete. We need to construct a fresh copy of
  // the form, passing in the latest $form_state in addition to any
  // other variables passed into drupal_get_form().

  if (!empty($form_state['rebuild']) || !empty($form_state['storage'])) {
114 115 116
    array_shift($args);
    array_unshift($args, $form_state);
    array_unshift($args, $form_id);
117
    $form = call_user_func_array('drupal_retrieve_form', $args);
118

119
    // We need a new build_id for the new version of the form.
120
    $form_build_id = 'form-'. md5(mt_rand());
121 122 123 124 125 126
    $form['#build_id'] = $form_build_id;
    drupal_prepare_form($form_id, $form, $form_state);

    // Now, we cache the form structure so it can be retrieved later for
    // validation. If $form_state['storage'] is populated, we'll also cache
    // it so that it can be used to resume complex multi-step processes.
127
    form_set_cache($form_build_id, $form, $form_state);
128 129 130 131 132 133 134

    // Clear out all post data, as we don't want the previous step's
    // data to pollute this one and trigger validate/submit handling,
    // then process the form for rendering.
    $_POST = array();
    $form['#post'] = array();
    drupal_process_form($form_id, $form, $form_state);
135 136
  }

137 138 139 140
  // If we haven't redirected to a new location by now, we want to
  // render whatever form array is currently in hand.
  return drupal_render_form($form_id, $form);
}
141

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
/**
 * Fetch a form from cache.
 */
function form_get_cache($form_build_id, &$form_state) {
  if ($cached = cache_get('form_'. $form_build_id, 'cache_form')) {
    $form = $cached->data;
    if ($cached = cache_get('storage_'. $form_build_id, 'cache_form')) {
      $form_state['storage'] = $cached->data;
    }
    return $form;
  }
}

/**
 * Store a form in the cache
 */
function form_set_cache($form_build_id, $form, $form_state) {
  $expire = max(ini_get('session.cookie_lifetime'), 86400);

  cache_set('form_'. $form_build_id, $form, 'cache_form', $expire);
  if (!empty($form_state['storage'])) {
    cache_set('storage_'. $form_build_id, $form_state['storage'], 'cache_form', $expire);
  }
}

167
/**
168
 * Retrieves a form using a form_id, populates it with $form_state['values'],
169 170 171 172 173 174 175 176
 * processes it, and returns any validation errors encountered. This
 * function is the programmatic counterpart to drupal_get_form().
 *
 * @param $form_id
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
177
 *   different $form_id values to the proper form constructor function. Examples
178
 *   may be found in node_forms(), search_forms(), and user_forms().
179 180 181 182 183
 * @param $form_state
 *   A keyed array containing the current state of the form. Most
 *   important is the $form_state['values'] collection, a tree of data
 *   used to simulate the incoming $_POST information from a user's
 *   form submission.
184
 * @param ...
185
 *   Any additional arguments needed by the form constructor function.
186 187 188 189
 *
 * For example:
 *
 * // register a new user
190 191 192 193 194
 * $form_state = array();
 * $form_state['values']['name'] = 'robo-user';
 * $form_state['values']['mail'] = 'robouser@example.com';
 * $form_state['values']['pass'] = 'password';
 * drupal_execute('user_register', $form_state);
195 196
 *
 * // Create a new node
197
 * $form_state = array();
198
 * $node = array('type' => 'story');
199 200 201 202
 * $form_state['values']['title'] = 'My node';
 * $form_state['values']['body'] = 'This is the body text!';
 * $form_state['values']['name'] = 'robo-user';
 * drupal_execute('story_node_form', $form_state, $node);
203
 */
204
function drupal_execute($form_id, &$form_state) {
205
  $args = func_get_args();
206 207 208 209
  $form = call_user_func_array('drupal_retrieve_form', $args);
  $form['#post'] = $form_state['values'];
  drupal_prepare_form($form_id, $form, $form_state);
  drupal_process_form($form_id, $form, $form_state);
210 211
}

212 213 214 215 216 217 218 219
/**
 * Retrieves the structured array that defines a given form.
 *
 * @param $form_id
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
220
 *   different $form_id values to the proper form constructor function.
221 222
 * @param $form_state
 *   A keyed array containing the current state of the form.
223
 * @param ...
224
 *   Any additional arguments needed by the form constructor function.
225
 */
226
function drupal_retrieve_form($form_id, &$form_state) {
227 228
  static $forms;

229
  // We save two copies of the incoming arguments: one for modules to use
230 231 232
  // when mapping form ids to constructor functions, and another to pass to
  // the constructor function itself. We shift out the first argument -- the
  // $form_id itself -- from the list to pass into the constructor function,
233
  // since it's already known.
234
  $args = func_get_args();
235
  $saved_args = $args;
236
  array_shift($args);
237 238 239
  if (isset($form_state)) {
    array_shift($args);
  }
240 241 242

  // We first check to see if there's a function named after the $form_id.
  // If there is, we simply pass the arguments on to it to get the form.
243
  if (!function_exists($form_id)) {
244
    // In cases where many form_ids need to share a central constructor function,
245
    // such as the node editing form, modules can implement hook_forms(). It
246
    // maps one or more form_ids to the correct constructor functions.
247 248 249 250 251 252 253 254 255
    //
    // We cache the results of that hook to save time, but that only works
    // for modules that know all their form_ids in advance. (A module that
    // adds a small 'rate this comment' form to each comment in a list
    // would need a unique form_id for each one, for example.)
    //
    // So, we call the hook if $forms isn't yet populated, OR if it doesn't
    // yet have an entry for the requested form_id.
    if (!isset($forms) || !isset($forms[$form_id])) {
256
      $forms = module_invoke_all('forms', $form_id, $args);
257 258 259 260 261 262 263 264 265
    }
    $form_definition = $forms[$form_id];
    if (isset($form_definition['callback arguments'])) {
      $args = array_merge($form_definition['callback arguments'], $args);
    }
    if (isset($form_definition['callback'])) {
      $callback = $form_definition['callback'];
    }
  }
266 267 268

  array_unshift($args, $form_state);

269 270
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
271 272 273 274 275 276
  $form = call_user_func_array(isset($callback) ? $callback : $form_id, $args);

  // We store the original function arguments, rather than the final $arg
  // value, so that form_alter functions can see what was originally
  // passed to drupal_retrieve_form(). This allows the contents of #parameters
  // to be saved and passed in at a later date to recreate the form.
277
  $form['#parameters'] = $saved_args;
278
  return $form;
279 280 281 282 283 284 285 286
}

/**
 * This function is the heart of form API. The form gets built, validated and in
 * appropriate cases, submitted.
 *
 * @param $form_id
 *   The unique string identifying the current form.
287 288
 * @param $form
 *   An associative array containing the structure of the form.
289 290
 * @param $form_state
 *   A keyed array containing the current state of the form. This
Dries's avatar
Dries committed
291
 *   includes the current persistent storage data for the form, and
292 293 294
 *   any data passed along by earlier steps when displaying a
 *   multi-step form. Additional information, like the sanitized $_POST
 *   data, is also accumulated here.
295
 */
296 297 298 299
function drupal_process_form($form_id, &$form, &$form_state) {
  $form_state['values'] = array();

  $form = form_builder($form_id, $form, $form_state);
300 301 302
  // Only process the form if it is programmed or the form_id coming
  // from the POST data is set and matches the current form_id.
  if ((!empty($form['#programmed'])) || (!empty($form['#post']) && (isset($form['#post']['form_id']) && ($form['#post']['form_id'] == $form_id)))) {
303 304 305 306 307 308 309 310 311
    drupal_validate_form($form_id, $form, $form_state);

    if ((!empty($form_state['submitted'])) && !form_get_errors() && empty($form_state['rebuild'])) {
      $form_state['redirect'] = NULL;
      form_execute_handlers('submit', $form, $form_state);

      // We'll clear out the cached copies of the form and its stored data
      // here, as we've finished with them. The in-memory copies are still
      // here, though.
312
      if (variable_get('cache', CACHE_DISABLED) == CACHE_DISABLED && !empty($form_state['values']['form_build_id'])) {
313 314 315 316 317
        cache_clear_all('form_'. $form_state['values']['form_build_id'], 'cache_form');
        cache_clear_all('storage_'. $form_state['values']['form_build_id'], 'cache_form');
      }

      // If batches were set in the submit handlers, we process them now,
318 319 320 321
      // possibly ending execution. We make sure we do not react to the batch
      // that is already being processed (if a batch operation performs a
      // drupal_execute).
      if ($batch =& batch_get() && !isset($batch['current_set'])) {
322 323 324 325
        // The batch uses its own copies of $form and $form_state for
        // late execution of submit handers and post-batch redirection.
        $batch['form'] = $form;
        $batch['form_state'] = $form_state;
326 327
        $batch['progressive'] = !$form['#programmed'];
        batch_process();
328 329 330 331
        // Execution continues only for programmatic forms.
        // For 'regular' forms, we get redirected to the batch processing
        // page. Form redirection will be handled in _batch_finished(),
        // after the batch is processed.
332
      }
333 334 335 336 337 338 339 340 341 342

      // If no submit handlers have populated the $form_state['storage']
      // bundle, and the $form_state['rebuild'] flag has not been set,
      // we're finished and should redirect to a new destination page
      // if one has been set (and a fresh, unpopulated copy of the form
      // if one hasn't). If the form was called by drupal_execute(),
      // however, we'll skip this and let the calling function examine
      // the resulting $form_state bundle itself.
      if (!$form['#programmed'] && empty($form_state['rebuild']) && empty($form_state['storage'])) {
         drupal_redirect_form($form, $form_state['redirect']);
343
      }
344 345 346 347 348 349 350 351 352 353 354 355 356 357
    }
  }
}

/**
 * Prepares a structured form array by adding required elements,
 * executing any hook_form_alter functions, and optionally inserting
 * a validation token to prevent tampering.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
358 359 360
 * @param $form_state
 *   A keyed array containing the current state of the form. Passed
 *   in here so that hook_form_alter() calls can use it, as well.
361
 */
362
function drupal_prepare_form($form_id, &$form, &$form_state) {
363 364
  global $user;

365
  $form['#type'] = 'form';
366
  $form['#programmed'] = isset($form['#post']);
367

368 369 370 371 372 373 374 375 376
  if (isset($form['#build_id'])) {
    $form['form_build_id'] = array(
      '#type' => 'hidden',
      '#value' => $form['#build_id'],
      '#id' => $form['#build_id'],
      '#name' => 'form_build_id',
    );
  }

377 378 379 380
  // Add a token, based on either #token or form_id, to any form displayed to
  // authenticated users. This ensures that any submitted form was actually
  // requested previously by the user and protects against cross site request
  // forgeries.
381
  if (isset($form['#token'])) {
382
    if ($form['#token'] === FALSE || $user->uid == 0 || $form['#programmed']) {
383
      unset($form['#token']);
384
    }
385
    else {
386
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
387
    }
388
  }
389
  else if (isset($user->uid) && $user->uid && !$form['#programmed']) {
390 391
    $form['#token'] = $form_id;
    $form['form_token'] = array(
392
      '#id' => form_clean_id('edit-'. $form_id .'-form-token'),
393 394 395 396 397
      '#type' => 'token',
      '#default_value' => drupal_get_token($form['#token']),
    );
  }

398
  if (isset($form_id)) {
399 400 401 402 403
    $form['form_id'] = array(
      '#type' => 'hidden',
      '#value' => $form_id,
      '#id' => form_clean_id("edit-$form_id"),
    );
404
  }
405
  if (!isset($form['#id'])) {
406
    $form['#id'] = form_clean_id($form_id);
407
  }
408

409
  $form += _element_info('form');
410

Dries's avatar
Dries committed
411 412
  if (!isset($form['#validate'])) {
    if (function_exists($form_id .'_validate')) {
413
      $form['#validate'] = array($form_id .'_validate');
Dries's avatar
Dries committed
414 415 416
    }
  }

417 418
  if (!isset($form['#submit'])) {
    if (function_exists($form_id .'_submit')) {
419
      // We set submit here so that it can be altered.
420
      $form['#submit'] = array($form_id .'_submit');
Dries's avatar
Dries committed
421 422 423
    }
  }

424
  drupal_alter('form_'. $form_id, $form, $form_state);
425
  drupal_alter('form', $form, $form_state, $form_id);
426 427
}

428 429

/**
430
 * Validates user-submitted form data from the $form_state using
431 432 433 434 435 436 437
 * the validate functions defined in a structured form array.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
438 439 440 441 442 443 444 445 446 447
 * @param $form_state
 *   A keyed array containing the current state of the form. The current
 *   user-submitted data is stored in $form_state['values'], though
 *   form validation functions are passed an explicit copy of the
 *   values for the sake of simplicity. Validation handlers can also
 *   $form_state to pass information on to submit handlers. For example:
 *     $form_state['data_for_submision'] = $data;
 *   This technique is useful when validation requires file parsing,
 *   web service requests, or other expensive requests that should
 *   not be repeated in the submission step.
448
 */
449
function drupal_validate_form($form_id, $form, &$form_state) {
450 451 452 453 454
  static $validated_forms = array();

  if (isset($validated_forms[$form_id])) {
    return;
  }
455

456
  // If the session token was set by drupal_prepare_form(), ensure that it
457
  // matches the current user's session.
458
  if (isset($form['#token'])) {
459
    if (!drupal_valid_token($form_state['values']['form_token'], $form['#token'])) {
460
      // Setting this error will cause the form to fail validation.
461
      form_set_error('form_token', t('Validation error, please try again. If this error persists, please contact the site administrator.'));
462 463 464
    }
  }

465
  _form_validate($form, $form_state, $form_id);
466
  $validated_forms[$form_id] = TRUE;
467 468
}

469 470 471 472 473 474 475 476 477 478 479 480
/**
 * Renders a structured form array into themed HTML.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
 * @return
 *   A string containing the path of the page to display when processing
 *   is complete.
 */
481
function drupal_render_form($form_id, &$form) {
482 483
  // Don't override #theme if someone already set it.
  if (!isset($form['#theme'])) {
484 485 486
    init_theme();
    $registry = theme_get_registry();
    if (isset($registry[$form_id])) {
487 488 489 490
      $form['#theme'] = $form_id;
    }
  }

491
  $output = drupal_render($form);
492 493 494 495 496 497 498 499 500
  return $output;
}

/**
 * Redirect the user to a URL after a form has been processed.
 *
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $redirect
501
 *   An optional value containing the destination path to redirect
502 503 504
 *   to if none is specified by the form.
 */
function drupal_redirect_form($form, $redirect = NULL) {
505
  $goto = NULL;
506 507 508
  if (isset($redirect)) {
    $goto = $redirect;
  }
509
  if ($goto !== FALSE && isset($form['#redirect'])) {
510 511
    $goto = $form['#redirect'];
  }
512 513 514 515 516 517 518 519 520 521 522
  if (!isset($goto) || ($goto !== FALSE)) {
    if (isset($goto)) {
      if (is_array($goto)) {
        call_user_func_array('drupal_goto', $goto);
      }
      else {
        drupal_goto($goto);
      }
    }
    drupal_goto($_GET['q']);
  }
523 524
}

525 526 527 528 529 530 531
/**
 * Performs validation on form elements. First ensures required fields are
 * completed, #maxlength is not exceeded, and selected options were in the
 * list of options given to the user. Then calls user-defined validators.
 *
 * @param $elements
 *   An associative array containing the structure of the form.
532 533 534 535 536 537 538 539 540 541
 * @param $form_state
 *   A keyed array containing the current state of the form. The current
 *   user-submitted data is stored in $form_state['values'], though
 *   form validation functions are passed an explicit copy of the
 *   values for the sake of simplicity. Validation handlers can also
 *   $form_state to pass information on to submit handlers. For example:
 *     $form_state['data_for_submision'] = $data;
 *   This technique is useful when validation requires file parsing,
 *   web service requests, or other expensive requests that should
 *   not be repeated in the submission step.
542 543 544 545
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 */
546
function _form_validate($elements, &$form_state, $form_id = NULL) {
547 548 549
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
550
      _form_validate($elements[$key], $form_state);
551 552
    }
  }
553
  /* Validate the current input */
554
  if (!isset($elements['#validated']) || !$elements['#validated']) {
555
    if (isset($elements['#needs_validation'])) {
556 557 558 559
      // An empty textfield returns '' so we use empty(). An empty checkbox
      // and a textfield could return '0' and empty('0') returns TRUE so we
      // need a special check for the '0' string.
      if ($elements['#required'] && empty($elements['#value']) && $elements['#value'] !== '0') {
560
        form_error($elements, t('!name field is required.', array('!name' => $elements['#title'])));
561
      }
562

563 564 565 566 567
      // Verify that the value is not longer than #maxlength.
      if (isset($elements['#maxlength']) && drupal_strlen($elements['#value']) > $elements['#maxlength']) {
        form_error($elements, t('!name cannot be longer than %max characters but is currently %length characters long.', array('!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'], '%max' => $elements['#maxlength'], '%length' => drupal_strlen($elements['#value']))));
      }

568 569
       // Add legal choice check if element has #options. Can be skipped, but
       // then you must validate your own element.
570 571 572 573 574 575 576 577 578 579 580 581
      if (isset($elements['#options']) && isset($elements['#value']) && !isset($elements['#DANGEROUS_SKIP_CHECK'])) {
        if ($elements['#type'] == 'select') {
          $options = form_options_flatten($elements['#options']);
        }
        else {
          $options = $elements['#options'];
        }
        if (is_array($elements['#value'])) {
          $value = $elements['#type'] == 'checkboxes' ? array_keys(array_filter($elements['#value'])) : $elements['#value'];
          foreach ($value as $v) {
            if (!isset($options[$v])) {
              form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
582
              watchdog('form', t('Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
583
            }
584 585
          }
        }
586 587
        elseif (!isset($options[$elements['#value']])) {
          form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
588
          watchdog('form', t('Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
589
        }
590 591 592
      }
    }

593 594 595 596 597 598 599 600
    // Call user-defined form level validators.
    if (isset($form_id)) {
      form_execute_handlers('validate', $elements, $form_state);
    }
    // Call any element-specific validators. These must act on the element
    // #value data.
    elseif (isset($elements['#element_validate'])) {
      foreach ($elements['#element_validate'] as $function) {
601
        if (function_exists($function))  {
602
          $function($elements, $form_state);
603 604 605
        }
      }
    }
606
    $elements['#validated'] = TRUE;
607 608 609
  }
}

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
/**
 * A helper function used to execute custom validation and submission
 * handlers for a given form. Button-specific handlers are checked
 * first. If none exist, the function falls back to form-level handlers.
 *
 * @param $type
 *   The type of handler to execute. 'validate' or 'submit' are the
 *   defaults used by Form API.
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $form_state
 *   A keyed array containing the current state of the form. If the user
 *   submitted the form by clicking a button with custom handler functions
 *   defined, those handlers will be stored here.
 */
function form_execute_handlers($type, &$form, &$form_state) {
  $return = FALSE;
  if (isset($form_state[$type .'_handlers'])) {
    $handlers = $form_state[$type .'_handlers'];
  }
  elseif (isset($form['#'. $type])) {
    $handlers = $form['#'. $type];
  }
  else {
    $handlers = array();
  }

  foreach ($handlers as $function) {
    if (function_exists($function))  {
      if ($type == 'submit' && ($batch =& batch_get())) {
        // Some previous _submit handler has set a batch. We store the call
        // in a special 'control' batch set, for execution at the correct
        // time during the batch processing workflow.
643
        $batch['sets'][] = array('form_submit' => $function);
644 645
      }
      else {
646
        $function($form, $form_state);
647 648 649 650 651 652 653
      }
      $return = TRUE;
    }
  }
  return $return;
}

654 655 656 657 658
/**
 * File an error against a form element. If the name of the element is
 * edit[foo][bar] then you may pass either foo or foo][bar as $name
 * foo will set an error for all its children.
 */
659
function form_set_error($name = NULL, $message = '') {
660 661 662
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
663 664 665
    if ($message) {
      drupal_set_message($message, 'error');
    }
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
  }
  return $form;
}

/**
 * Return an associative array of all errors.
 */
function form_get_errors() {
  $form = form_set_error();
  if (!empty($form)) {
    return $form;
  }
}

/**
 * Return the error message filed against the form with the specified name.
 */
function form_get_error($element) {
  $form = form_set_error();
  $key = $element['#parents'][0];
  if (isset($form[$key])) {
    return $form[$key];
  }
  $key = implode('][', $element['#parents']);
  if (isset($form[$key])) {
    return $form[$key];
  }
}

695 696 697
/**
 * Flag an element as having an error.
 */
698
function form_error(&$element, $message = '') {
699
  form_set_error(implode('][', $element['#parents']), $message);
700 701 702
}

/**
703 704 705
 * Walk through the structured form array, adding any required
 * properties to each element and mapping the incoming $_POST
 * data to the proper elements.
706 707
 *
 * @param $form_id
708 709
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
710 711
 * @param $form
 *   An associative array containing the structure of the form.
712 713 714 715 716
 * @param $form_state
 *   A keyed array containing the current state of the form. In this
 *   context, it is used to accumulate information about which button
 *   was clicked when the form was submitted, as well as the sanitized
 *   $_POST data.
717
 */
718
function form_builder($form_id, $form, &$form_state) {
719 720 721
  // Initialize as unprocessed.
  $form['#processed'] = FALSE;

722
  /* Use element defaults */
723
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
724
    // Overlay $info onto $form, retaining preexisting keys in $form.
725 726 727
    $form += $info;
  }

728 729 730 731
  if (isset($form['#type']) && $form['#type'] == 'form' && !empty($form['#programmed'])) {
    $form_state['submitted'] = TRUE;
  }

732
  if (isset($form['#input']) && $form['#input']) {
733
    _form_builder_handle_input_element($form_id, $form, $form_state);
734
  }
735
  $form['#defaults_loaded'] = TRUE;
736

737 738 739
  // We start off assuming all form elements are in the correct order.
  $form['#sorted'] = TRUE;

740
  // Recurse through all child elements.
741
  $count = 0;
742
  foreach (element_children($form) as $key) {
743 744
    $form[$key]['#post'] = $form['#post'];
    $form[$key]['#programmed'] = $form['#programmed'];
745
    // Don't squash an existing tree value.
746 747 748
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
749

750
    // Deny access to child elements if parent is denied.
751 752 753 754
    if (isset($form['#access']) && !$form['#access']) {
      $form[$key]['#access'] = FALSE;
    }

755
    // Don't squash existing parents value.
756
    if (!isset($form[$key]['#parents'])) {
757 758
      // Check to see if a tree of child elements is present. If so,
      // continue down the tree if required.
759
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
760 761
    }

762
    // Assign a decimal placeholder weight to preserve original array order.
763 764 765
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
766
    else {
767 768
      // If one of the child elements has a weight then we will need to sort
      // later.
769 770
      unset($form['#sorted']);
    }
771
    $form[$key] = form_builder($form_id, $form[$key], $form_state);
772 773 774
    $count++;
  }

775 776
  // The #after_build flag allows any piece of a form to be altered
  // after normal input parsing has been completed.
777 778
  if (isset($form['#after_build']) && !isset($form['#after_build_done'])) {
    foreach ($form['#after_build'] as $function) {
779
      $form = $function($form, $form_state);
780 781 782 783 784
      $form['#after_build_done'] = TRUE;
    }
  }

  // Now that we've processed everything, we can go back to handle the funky
Dries's avatar
Dries committed
785
  // Internet Explorer button-click scenario.
786 787
  _form_builder_ie_cleanup($form, $form_state);

788 789 790
  // After handling the special IE case, we no longer need the buttons collection.
  unset($form_state['buttons']);

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
  return $form;
}

/**
 * Populate the #value and #name properties of input elements so they
 * can be processed and rendered. Also, execute any #process handlers
 * attached to a specific element.
 */
function _form_builder_handle_input_element($form_id, &$form, &$form_state) {
  if (!isset($form['#name'])) {
    $name = array_shift($form['#parents']);
    $form['#name'] = $name;
    if ($form['#type'] == 'file') {
      // To make it easier to handle $_FILES in file.inc, we place all
      // file fields in the 'files' array. Also, we do not support
      // nested file names.
      $form['#name'] = 'files['. $form['#name'] .']';
    }
    elseif (count($form['#parents'])) {
      $form['#name'] .= '['. implode('][', $form['#parents']) .']';
    }
    array_unshift($form['#parents'], $name);
  }
  if (!isset($form['#id'])) {
    $form['#id'] = form_clean_id('edit-'. implode('-', $form['#parents']));
  }

818
  unset($edit);
819 820 821 822 823
  if (!empty($form['#disabled'])) {
    $form['#attributes']['disabled'] = 'disabled';
  }

  if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
824
    $function = !empty($form['#value_callback']) ? $form['#value_callback'] : 'form_type_'. $form['#type'] .'_value';
825 826 827 828 829 830
    if (($form['#programmed']) || ((!isset($form['#access']) || $form['#access']) && isset($form['#post']) && (isset($form['#post']['form_id']) && $form['#post']['form_id'] == $form_id))) {
      $edit = $form['#post'];
      foreach ($form['#parents'] as $parent) {
        $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      }
      if (!$form['#programmed'] || isset($edit)) {
831 832 833
        // Call #type_value to set the form value;
        if (function_exists($function)) {
          $form['#value'] = $function($form, $edit);
834
        }
835 836
        if (!isset($form['#value']) && isset($edit)) {
          $form['#value'] = $edit;
837 838
        }
      }
839 840 841 842
      // Mark all posted values for validation.
      if (isset($form['#value']) || (isset($form['#required']) && $form['#required'])) {
        $form['#needs_validation'] = TRUE;
      }
843
    }
844
    // Load defaults.
845
    if (!isset($form['#value'])) {
846
      // Call #type_value without a second argument to request default_value handling.
847
      if (function_exists($function)) {
848
        $form['#value'] = $function($form);
849
      }
850
      // Final catch. If we haven't set a value yet, use the explicit default value.
851
      if (!isset($form['#value'])) {
852
        $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
853 854
      }
    }
855
  }
856

857 858 859 860 861 862 863 864 865 866
  // Determine which button (if any) was clicked to submit the form.
  // We compare the incoming values with the buttons defined in the form,
  // and flag the one that matches. We have to do some funky tricks to
  // deal with Internet Explorer's handling of single-button forms, though.
  if (!empty($form['#post']) && isset($form['#executes_submit_callback'])) {
    // First, accumulate a collection of buttons, divided into two bins:
    // those that execute full submit callbacks and those that only validate.
    $button_type = $form['#executes_submit_callback'] ? 'submit' : 'button';
    $form_state['buttons'][$button_type][] = $form;

867
    if (_form_button_was_clicked($form)) {
868 869 870 871 872 873
      $form_state['submitted'] = $form_state['submitted'] || $form['#executes_submit_callback'];

      // In most cases, we want to use form_set_value() to manipulate
      // the global variables. In this special case, we want to make sure that
      // the value of this element is listed in $form_variables under 'op'.
      $form_state['values'][$form['#name']] = $form['#value'];
874
      $form_state['clicked_button'] = $form;
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897

      if (isset($form['#validate'])) {
        $form_state['validate_handlers'] = $form['#validate'];
      }
      if (isset($form['#submit'])) {
        $form_state['submit_handlers'] = $form['#submit'];
      }
    }
  }
  // Allow for elements to expand to multiple elements, e.g., radios,
  // checkboxes and files.
  if (isset($form['#process']) && !$form['#processed']) {
    foreach ($form['#process'] as $process) {
      if (function_exists($process)) {
        $args = array_merge(array($form), array(isset($edit) ? $edit : NULL), array($form_state));
        $form = call_user_func_array($process, $args);
      }
    }
    $form['#processed'] = TRUE;
  }
  form_set_value($form, $form['#value'], $form_state);
}

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
/**
 * Helper function to handle the sometimes-convoluted logic of button
 * click detection.
 *
 * In Internet Explorer, if ONLY one submit button is present, AND the
 * enter key is used to submit the form, no form value is sent for it
 * and we'll never detect a match. That special case is handled by
 * _form_builder_ie_cleanup().
 */
function _form_button_was_clicked($form) {
  // First detect normal 'vanilla' button clicks. Traditionally, all
  // standard buttons on a form share the same name (usually 'op'),
  // and the specific return value is used to determine which was
  // clicked. This ONLY works as long as $form['#name'] puts the
  // value at the top level of the tree of $_POST data.
  if (isset($form['#post'][$form['#name']]) && $form['#post'][$form['#name']] == $form['#value']) {
    return TRUE;
  }
  // When image buttons are clicked, browsers do NOT pass the form element
  // value in $_POST. Instead they pass an integer representing the
  // coordinates of the click on the button image. This means that image
  // buttons MUST have unique $form['#name'] values, but the details of
  // their $_POST data should be ignored.
  elseif (!empty($form['#has_garbage_value']) && isset($form['#value']) && $form['#value'] !== '') {
    return TRUE;
  }
  return FALSE;
}

/**
 * In IE, if only one submit button is present, AND the enter key is
 * used to submit the form, no form value is sent for it and our normal
 * button detection code will never detect a match. We call this
 * function after all other button-detection is complete to check
 * for the proper conditions, and treat the single button on the form
 * as 'clicked' if they are met.
 */
function _form_builder_ie_cleanup($form, &$form_state) {
  // Quick check to make sure we're always looking at the full form
  // and not a sub-element.
  if (!empty($form['#type']) && $form['#type'] == 'form') {
    // If we haven't recognized a submission yet, and there's a single
    // submit button, we know that we've hit the right conditions. Grab
    // the first one and treat it as the clicked button.
    if (empty($form_state['submitted']) && !empty($form_state['buttons']['submit']) && empty($form_state['buttons']['button'])) {
      $button = $form_state['buttons']['submit'][0];

      // Set up all the $form_state information that would have been
      // populated had the button been recognized earlier.
      $form_state['submitted'] = TRUE;
      $form_state['submit_handlers'] = empty($button['#submit']) ? NULL : $button['#submit'];
      $form_state['validate_handlers'] = empty($button['#validate']) ? NULL : $button['#validate'];
      $form_state['values'][$button['#name']] = $button['#value'];
      $form_state['clicked_button'] = $button;
    }
  }
}

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
/**
 * Helper function to determine the value for an image button form element.
 *
 * @param $form
 *   The form element whose value is being populated.
 * @param $edit
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
 * @return
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
 */
function form_type_image_button_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
    if (!empty($edit)) {
      // If we're dealing with Mozilla or Opera, we're lucky. It will
      // return a proper value, and we can get on with things.
      return $form['#return_value'];
    }
    else {
      // Unfortunately, in IE we never get back a proper value for THIS
      // form element. Instead, we get back two split values: one for the
      // X and one for the Y coordinates on which the user clicked the
      // button. We'll find this element in the #post data, and search
      // in the same spot for its name, with '_x'.
      $post = $form['#post'];
      foreach (split('\[', $form['#name']) as $element_name) {
        // chop off the ] that may exist.
        if (substr($element_name, -1) == ']') {
          $element_name = substr($element_name, 0, -1);
        }

        if (!isset($post[$element_name])) {
          if (isset($post[$element_name .'_x'])) {
            return $form['#return_value'];
          }
          return NULL;
        }
        $post = $array[$element_name];
      }
      return $form['#return_value'];
    }
  }
}

1001 1002 1003 1004
/**
 * Helper function to determine the value for a checkbox form element.
 *
 * @param $form
1005
 *   The form element whose value is being populated.
1006
 * @param $edit
1007 1008
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1009
 * @return
1010 1011
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1012
 */
1013 1014
function form_type_checkbox_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1015 1016 1017 1018 1019 1020 1021 1022
    return !empty($edit) ? $form['#return_value'] : 0;
  }
}

/**
 * Helper function to determine the value for a checkboxes form element.
 *
 * @param $form
1023
 *   The form element whose value is being populated.
1024
 * @param $edit
1025 1026
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1027
 * @return
1028 1029
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1030
 */
1031
function form_type_checkboxes_value($form, $edit = FALSE) {
1032
  if ($edit === FALSE) {
1033 1034 1035 1036 1037 1038 1039
    $value = array();
    $form += array('#default_value' => array());
    foreach ($form['#default_value'] as $key) {
      $value[$key] = 1;
    }
    return $value;
  }
1040 1041 1042
  elseif (!isset($edit)) {
    return array();
  }
1043 1044 1045 1046 1047 1048 1049
}

/**
 * Helper function to determine the value for a password_confirm form
 * element.
 *
 * @param $form
1050
 *   The form element whose value is being populated.
1051
 * @param $edit
1052 1053
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1054
 * @return
1055 1056
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1057
 */
1058 1059
function form_type_password_confirm_value($form, $edit = FALSE) {
  if ($edit === FALSE) {
1060 1061 1062 1063 1064 1065 1066 1067 1068
    $form += array('#default_value' => array());
    return $form['#default_value'] + array('pass1' => '', 'pass2' => '');
  }
}

/**
 * Helper function to determine the value for a select form element.
 *
 * @param $form
1069
 *   The form element whose value is being populated.
1070
 * @param $edit
1071 1072
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1073
 * @return
1074 1075
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1076
 */
1077 1078
function form_type_select_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
    if (isset($form['#multiple']) && $form['#multiple']) {
      return (is_array($edit)) ? drupal_map_assoc($edit) : array();
    }
    else {
      return $edit;
    }
  }
}

/**
 * Helper function to determine the value for a textfield form element.
 *
 * @param $form
1092
 *   The form element whose value is being populated.
1093
 * @param $edit
1094 1095
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1096
 * @return
1097 1098
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1099
 */
1100 1101
function form_type_textfield_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
    // Equate $edit to the form value to ensure it's marked for
    // validation.
    return str_replace(array("\r", "\n"), '', $edit);
  }
}

/**
 * Helper function to determine the value for form's token value.
 *
 * @param $form
1112
 *   The form element whose value is being populated.
1113
 * @param $edit
1114 1115
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
1116
 * @return
1117 1118
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
1119
 */
1120 1121
function form_type_token_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
1122 1123 1124 1125
    return (string)$edit;
  }
}

1126
/**
Dries's avatar
Dries committed
1127
 * Use this function to make changes to form values in the form validate
1128
 * phase, so they will be available in the submit phase in $form_state.
1129 1130 1131
 *
 * Specifically, if $form['#parents'] is array('foo', 'bar')
 * and $value is 'baz' then this function will make
1132
 * $form_state['values']['foo']['bar'] to be 'baz'.
1133 1134 1135 1136 1137 1138
 *
 * @param $form
 *   The form item. Keys used: #parents, #value
 * @param $value
 *   The value for the form item.
 */
1139 1140
function form_set_value($form, $value, &$form_state) {
  _form_set_value($form_state['values'], $form, $form['#parents'], $value);
1141 1142 1143 1144 1145
}

/**
 * Helper function for form_set_value().
 *
1146
 * We iterate over $parents and create nested arrays for them
1147
 * in $form_state['values'] if needed. Then we insert the value into
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
 * the right array.
 */
function _form_set_value(&$form_values, $form, $parents, $value) {
  $parent = array_shift($parents);
  if (empty($parents)) {
    $form_values[$parent] = $value;
  }
  else {
    if (!isset($form_values[$parent])) {
      $form_values[$parent] = array();
    }
    _form_set_value($form_values[$parent], $form, $parents, $value);
  }
}

1163 1164 1165
/**
 * Retrieve the default properties for the defined element type.
 */
1166
function _element_info($type, $refresh = NULL) {
1167
  static $cache;
1168

1169
  $basic_defaults = array(
1170 1171 1172
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
1173
    '#tree' => FALSE,
1174
    '#parents' => array()
1175
  );
1176
  if (!isset($cache) || $refresh) {
1177 1178 1179
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
1180
      if (isset($elements) && is_array($elements)) {
1181
        $cache = array_merge_recursive($cache, $elements);
1182 1183 1184 1185
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
1186
        $cache[$element_type] = array_merge_recursive($basic_defaults, $info);
1187 1188 1189 1190 1191 1192 1193
      }
    }
  }

  return $cache[$type];
}

1194 1195 1196 1197 1198 1199 1200 1201
function form_options_flatten($array, $reset = TRUE) {
  static $return;

  if ($reset) {
    $return = array();
  }

  foreach ($array as $key => $value) {
1202 1203 1204 1205
    if (is_object($value)) {
      form_options_flatten($value->option, FALSE);
    }
    else if (is_array($value)) {
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
      form_options_flatten($value, FALSE);
    }
    else {
      $return[$key] = 1;
    }
  }

  return $return;
}

1216 1217 1218 1219 1220
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1221
 *   Properties used: title, value, options, description, extra, multiple, required
1222 1223 1224 1225 1226 1227 1228 1229 1230
 * @return
 *   A themed HTML string representing the form element.
 *
 * It is possible to group options together; to do this, change the format of
 * $options to an associative array in which the keys are group labels, and the
 * values are associative arrays in the normal $options format.
 */
function theme_select($element) {
  $select = '';
1231
  $size = $element['#size'] ? ' size="'. $element['#size'] .'"' : '';
1232
  _form_set_class($element, array('form-select'));
1233
  $multiple = $element['#multiple'];
1234
  return theme('form_element', $element, '<select name="'. $element['#name'] .''. ($multiple ? '[]' : '') .'"'. ($multiple ? ' multiple="multiple" ' : '') . drupal_attributes($element['#attributes']) .' id="'. $element['#id'] .'" '. $size .'>'. form_select_options($element) .'</select>');
1235 1236 1237 1238 1239 1240
}

function form_select_options($element, $choices = NULL) {
  if (!isset($choices)) {
    $choices = $element['#options'];
  }
1241
  // array_key_exists() accommodates the rare event where $element['#value'] is NULL.
1242 1243 1244
  // isset() fails in this situation.
  $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  $value_is_array = is_array($element['#value']);
1245 1246
  $options = '';
  foreach ($choices as $key => $choice) {
1247
    if (is_array($choice)) {
1248 1249 1250
      $options .= '<optgroup label="'. $key .'">';
      $options .= form_select_options($element, $choice);
      $options .= '</optgroup>';
1251
    }
1252 1253 1254
    elseif (is_object($choice)) {
      $options .= form_select_options($element, $choice->option);
    }
1255
    else {
1256
      $key = (string)$key;
1257
      if ($value_valid && (!$value_is_array && (string)$element['#value'] === $key || ($value_is_array && in_array($key, $element['#value'])))) {
1258 1259 1260 1261 1262
        $selected = ' selected="selected"';
      }
      else {
        $selected = '';
      }
1263
      $options .= '<option value="'. $key .'"'. $selected .'>'. check_plain($choice) .'</option>';
1264 1265
    }
  }
1266
  return $options;
1267 1268
}

1269