form.inc 70.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 56
  $form_state = array('storage' => NULL, 'submitted' => FALSE);
  $expire = max(ini_get('session.cookie_lifetime'), 86400);

  $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']);
57 58
  }
  else {
59 60 61 62 63 64 65 66 67 68 69 70
    // 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'])) {
      if ($cached = cache_get('form_'. $_POST['form_build_id'], 'cache_form')) {
        $form = $cached->data;
        if ($cached = cache_get('storage_'. $_POST['form_build_id'], 'cache_form')) {
          $form_state['storage'] = $cached->data;
        }
      }
71 72
    }

73 74 75 76
    // 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)) {
77
      $form_state['post'] = $_POST;
78
      $form = call_user_func_array('drupal_retrieve_form', $args);
79
      $form_build_id = 'form-'. md5(mt_rand());
80
      $form['#build_id'] = $form_build_id;
81 82 83 84
      drupal_prepare_form($form_id, $form, $form_state);
      if (!empty($form['#cache'])) {
        cache_set('form_'. $form_build_id, $form, 'cache_form', $expire);
      }
85
      unset($form_state['post']);
86
    }
87
    $form['#post'] = $_POST;
88

89 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'])) {
    $args[] = $form_state;
    $form = call_user_func_array('drupal_retrieve_form', $args);
114

115
    // We need a new build_id for the new version of the form.
116
    $form_build_id = 'form-'. md5(mt_rand());
117 118 119 120 121 122 123 124 125
    $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.
    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);
126
    }
127 128 129 130 131 132 133

    // 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);
134 135
  }

136 137 138 139
  // 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);
}
140

141
/**
142
 * Retrieves a form using a form_id, populates it with $form_state['values'],
143 144 145 146 147 148 149 150
 * 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
151
 *   different $form_id values to the proper form constructor function. Examples
152
 *   may be found in node_forms(), search_forms(), and user_forms().
153 154 155 156 157
 * @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.
158
 * @param ...
159
 *   Any additional arguments needed by the form constructor function.
160 161 162 163
 *
 * For example:
 *
 * // register a new user
164 165 166 167 168
 * $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);
169 170
 *
 * // Create a new node
171
 * $form_state = array();
172
 * $node = array('type' => 'story');
173 174 175 176
 * $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);
177
 */
178
function drupal_execute($form_id, &$form_state) {
179 180
  $args = func_get_args();

181 182 183 184
  // We do a bit of juggling here because drupal_retrieve_form() expects
  // the $form_state to be the last parameter, while drupal_execute()
  // always takes it in as the second parameter.
  $args = array_slice($args, 3);
185
  array_unshift($args, $form_id);
186
  $args[] = $form_state;
187

188 189 190 191
  $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);
192 193
}

194 195 196 197 198 199 200 201
/**
 * 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
202
 *   different $form_id values to the proper form constructor function.
203
 * @param ...
204
 *   Any additional arguments needed by the form constructor function.
205 206 207 208
 */
function drupal_retrieve_form($form_id) {
  static $forms;

209
  // We save two copies of the incoming arguments: one for modules to use
210 211 212
  // 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,
213
  // since it's already known.
214
  $args = func_get_args();
215
  $saved_args = $args;
216
  array_shift($args);
217 218 219

  // 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.
220
  if (!function_exists($form_id)) {
221
    // In cases where many form_ids need to share a central constructor function,
222
    // such as the node editing form, modules can implement hook_forms(). It
223
    // maps one or more form_ids to the correct constructor functions.
224 225 226 227 228 229 230 231 232
    //
    // 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])) {
233
      $forms = module_invoke_all('forms', $form_id, $args);
234 235 236 237 238 239 240 241 242
    }
    $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'];
    }
  }
243 244
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
245 246 247 248 249 250
  $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.
251
  $form['#parameters'] = $saved_args;
252
  return $form;
253 254 255 256 257 258 259 260
}

/**
 * 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.
261 262
 * @param $form
 *   An associative array containing the structure of the form.
263 264 265 266 267 268
 * @param $form_state
 *   A keyed array containing the current state of the form. This
 *   includes the current persistant storage data for the form, and
 *   any data passed along by earlier steps when displaying a
 *   multi-step form. Additional information, like the sanitized $_POST
 *   data, is also accumulated here.
269
 */
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
function drupal_process_form($form_id, &$form, &$form_state) {
  $form_state['values'] = array();

  $form = form_builder($form_id, $form, $form_state);
  if ((!empty($form['#programmed'])) || (!empty($form['#post']) && (($form['#post']['form_id'] == $form_id)))) {
    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.
      if (variable_get('cache', CACHE_DISABLED) == CACHE_DISABLED) {
        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,
      // possibly ending execution.
291
      if ($batch =& batch_get()) {
292 293 294 295
        // 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;
296 297
        $batch['progressive'] = !$form['#programmed'];
        batch_process();
298 299 300 301
        // 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.
302
      }
303 304 305 306 307 308 309 310 311 312

      // 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']);
313
      }
314 315 316 317 318 319 320 321 322 323 324 325 326 327
    }
  }
}

/**
 * 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.
328 329 330
 * @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.
331
 */
332
function drupal_prepare_form($form_id, &$form, &$form_state) {
333 334
  global $user;

335
  $form['#type'] = 'form';
336
  $form['#programmed'] = isset($form['#post']);
337

338 339 340 341 342 343 344 345 346
  if (isset($form['#build_id'])) {
    $form['form_build_id'] = array(
      '#type' => 'hidden',
      '#value' => $form['#build_id'],
      '#id' => $form['#build_id'],
      '#name' => 'form_build_id',
    );
  }

347 348 349 350
  // 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.
351
  if (isset($form['#token'])) {
352
    if ($form['#token'] === FALSE || $user->uid == 0 || $form['#programmed']) {
353
      unset($form['#token']);
354
    }
355
    else {
356
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
357
    }
358
  }
359
  else if (isset($user->uid) && $user->uid && !$form['#programmed']) {
360 361
    $form['#token'] = $form_id;
    $form['form_token'] = array(
362
      '#id' => form_clean_id('edit-'. $form_id .'-form-token'),
363 364 365 366 367
      '#type' => 'token',
      '#default_value' => drupal_get_token($form['#token']),
    );
  }

368
  if (isset($form_id)) {
369 370 371 372 373
    $form['form_id'] = array(
      '#type' => 'hidden',
      '#value' => $form_id,
      '#id' => form_clean_id("edit-$form_id"),
    );
374
  }
375
  if (!isset($form['#id'])) {
376
    $form['#id'] = form_clean_id($form_id);
377
  }
378

379
  $form += _element_info('form');
380

Dries's avatar
Dries committed
381 382
  if (!isset($form['#validate'])) {
    if (function_exists($form_id .'_validate')) {
383
      $form['#validate'] = array($form_id .'_validate');
Dries's avatar
Dries committed
384 385 386
    }
  }

387 388
  if (!isset($form['#submit'])) {
    if (function_exists($form_id .'_submit')) {
389
      // We set submit here so that it can be altered.
390
      $form['#submit'] = array($form_id .'_submit');
Dries's avatar
Dries committed
391 392 393
    }
  }

394
  drupal_alter('form_'. $form_id, $form, $form_state);
395
  drupal_alter('form', $form, $form_state, $form_id);
396 397
}

398 399

/**
400
 * Validates user-submitted form data from the $form_state using
401 402 403 404 405 406 407
 * 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.
408 409 410 411 412 413 414 415 416 417
 * @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.
418
 */
419
function drupal_validate_form($form_id, $form, &$form_state) {
420 421 422 423 424
  static $validated_forms = array();

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

426
  // If the session token was set by drupal_prepare_form(), ensure that it
427
  // matches the current user's session.
428
  if (isset($form['#token'])) {
429
    if (!drupal_valid_token($form_state['values']['form_token'], $form['#token'])) {
430
      // Setting this error will cause the form to fail validation.
431
      form_set_error('form_token', t('Validation error, please try again. If this error persists, please contact the site administrator.'));
432 433 434
    }
  }

435
  _form_validate($form, $form_state, $form_id);
436
  $validated_forms[$form_id] = TRUE;
437 438
}

439 440 441 442 443 444 445 446 447 448 449 450
/**
 * 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.
 */
451
function drupal_render_form($form_id, &$form) {
452 453
  // Don't override #theme if someone already set it.
  if (!isset($form['#theme'])) {
454 455 456
    init_theme();
    $registry = theme_get_registry();
    if (isset($registry[$form_id])) {
457 458 459 460
      $form['#theme'] = $form_id;
    }
  }

461
  $output = drupal_render($form);
462 463 464 465 466 467 468 469 470
  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
471
 *   An optional value containing the destination path to redirect
472 473 474
 *   to if none is specified by the form.
 */
function drupal_redirect_form($form, $redirect = NULL) {
475
  $goto = NULL;
476 477 478
  if (isset($redirect)) {
    $goto = $redirect;
  }
479
  if ($goto !== FALSE && isset($form['#redirect'])) {
480 481
    $goto = $form['#redirect'];
  }
482 483 484 485 486 487 488 489
  if (!isset($goto) || ($goto !== FALSE)) {
    if (isset($goto)) {
      if (is_array($goto)) {
        call_user_func_array('drupal_goto', $goto);
      }
      else {
        drupal_goto($goto);
      }
490
    }
491
    drupal_goto($_GET['q']);
492 493 494
  }
}

495 496 497 498 499 500 501
/**
 * 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.
502 503 504 505 506 507 508 509 510 511
 * @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.
512 513 514 515
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 */
516
function _form_validate($elements, &$form_state, $form_id = NULL) {
517 518 519
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
520
      _form_validate($elements[$key], $form_state);
521 522
    }
  }
523
  /* Validate the current input */
524
  if (!isset($elements['#validated']) || !$elements['#validated']) {
525
    if (isset($elements['#needs_validation'])) {
526 527 528 529
      // 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') {
530
        form_error($elements, t('!name field is required.', array('!name' => $elements['#title'])));
531
      }
532

533 534 535 536 537
      // 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']))));
      }

538 539
       // Add legal choice check if element has #options. Can be skipped, but
       // then you must validate your own element.
540 541 542 543 544 545 546 547 548 549 550 551
      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.'));
552
              watchdog('form', t('Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
553
            }
554 555
          }
        }
556 557
        elseif (!isset($options[$elements['#value']])) {
          form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
558
          watchdog('form', t('Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
559
        }
560 561 562
      }
    }

563 564 565 566 567 568 569 570
    // 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) {
571
        if (function_exists($function))  {
572
          $function($elements, $form_state);
573 574 575
        }
      }
    }
576
    $elements['#validated'] = TRUE;
577 578 579
  }
}

580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
/**
 * 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.
613
        $batch['sets'][] = array('form_submit' => $function);
614 615
      }
      else {
616
        $function($form, $form_state, $form_state['values']);
617 618 619 620 621 622 623
      }
      $return = TRUE;
    }
  }
  return $return;
}

624 625 626 627 628
/**
 * 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.
 */
629
function form_set_error($name = NULL, $message = '') {
630 631 632
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
633 634 635
    if ($message) {
      drupal_set_message($message, 'error');
    }
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
  }
  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];
  }
}

665 666 667
/**
 * Flag an element as having an error.
 */
668
function form_error(&$element, $message = '') {
669
  $element['#error'] = TRUE;
670
  form_set_error(implode('][', $element['#parents']), $message);
671 672 673
}

/**
674 675 676
 * Walk through the structured form array, adding any required
 * properties to each element and mapping the incoming $_POST
 * data to the proper elements.
677 678
 *
 * @param $form_id
679 680
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
681 682
 * @param $form
 *   An associative array containing the structure of the form.
683 684 685 686 687
 * @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.
688
 */
689
function form_builder($form_id, $form, &$form_state) {
690 691 692
  // Initialize as unprocessed.
  $form['#processed'] = FALSE;

693
  /* Use element defaults */
694
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
695
    // Overlay $info onto $form, retaining preexisting keys in $form.
696 697 698
    $form += $info;
  }

699
  if (isset($form['#input']) && $form['#input']) {
700
    _form_builder_handle_input_element($form_id, $form, $form_state);
701 702
  }

703 704 705
  // We start off assuming all form elements are in the correct order.
  $form['#sorted'] = TRUE;

706
  // Recurse through all child elements.
707
  $count = 0;
708
  foreach (element_children($form) as $key) {
709 710
    $form[$key]['#post'] = $form['#post'];
    $form[$key]['#programmed'] = $form['#programmed'];
711
    // Don't squash an existing tree value.
712 713 714
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
715

716
    // Deny access to child elements if parent is denied.
717 718 719 720
    if (isset($form['#access']) && !$form['#access']) {
      $form[$key]['#access'] = FALSE;
    }

721
    // Don't squash existing parents value.
722
    if (!isset($form[$key]['#parents'])) {
723 724
      // Check to see if a tree of child elements is present. If so,
      // continue down the tree if required.
725
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
726 727
    }

728
    // Assign a decimal placeholder weight to preserve original array order.
729 730 731
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
732
    else {
733 734
      // If one of the child elements has a weight then we will need to sort
      // later.
735 736
      unset($form['#sorted']);
    }
737
    $form[$key] = form_builder($form_id, $form[$key], $form_state);
738 739 740
    $count++;
  }

741 742
  // The #after_build flag allows any piece of a form to be altered
  // after normal input parsing has been completed.
743 744
  if (isset($form['#after_build']) && !isset($form['#after_build_done'])) {
    foreach ($form['#after_build'] as $function) {
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
      $form = $function($form, $form_state['values'], $form_state);
      $form['#after_build_done'] = TRUE;
    }
  }

  // Now that we've processed everything, we can go back to handle the funky
  // Internet Explorer button-click scenerio.
  _form_builder_ie_cleanup($form, $form_state);

  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) {
763
  if (isset($form['#type']) && $form['#type'] == 'form' && !empty($form['#programmed'])) {
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 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 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
    $form_state['submitted'] = TRUE;
  }

  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']));
  }

  if (!empty($form['#disabled'])) {
    $form['#attributes']['disabled'] = 'disabled';
  }

  if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
    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)) {
        switch ($form['#type']) {
          case 'checkbox':
            $form['#value'] = !empty($edit) ? $form['#return_value'] : 0;
            break;

          case 'select':
            if (isset($form['#multiple']) && $form['#multiple']) {
              if (isset($edit) && is_array($edit)) {
                $form['#value'] = drupal_map_assoc($edit);
              }
              else {
                $form['#value'] = array();
              }
            }
            elseif (isset($edit)) {
              $form['#value'] = $edit;
            }
            break;

          case 'textfield':
            if (isset($edit)) {
              // Equate $edit to the form value to ensure it's marked for
              // validation.
              $edit = str_replace(array("\r", "\n"), '', $edit);
              $form['#value'] = $edit;
            }
            break;

          case 'token':
            $form['#value'] = (string)$edit;
            break;

          default:
            if (isset($edit)) {
              $form['#value'] = $edit;
            }
        }
        // Mark all posted values for validation.
        if ((isset($form['#value']) && $form['#value'] === $edit) || (isset($form['#required']) && $form['#required'])) {
          $form['#needs_validation'] = TRUE;
        }
      }
    }
    if (!isset($form['#value'])) {
      $function = 'form_'. $form['#type'] .'_value';
841
      if (function_exists($function)) {
842 843 844 845
        $function($form);
      }
      else {
        $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
846 847
      }
    }
848
  }
849

850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
  // 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;

    // See if a submit button was clicked. 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. In most cases, though, the following code will properly handle
    // finding the clicked button and storing any custom validate and
    // submit handlers it has defined.
    if (isset($form['#post'][$form['#name']]) && $form['#post'][$form['#name']] == $form['#value']) {
      $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'];

      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);
}

/**
 * Handle the special Internet Explorer one-button-form hit-enter-
 * instead-of-clicking scenerio.
 */
function _form_builder_ie_cleanup($form, &$form_state) {
  if (!empty($form['#type']) && $form['#type'] == 'form') {
    // If the 'submitted' flag isn't tripped, but there is only one submit button...
    if (empty($form_state['submitted']) && !empty($form_state['buttons']['submit']) && empty($form_state['buttons']['button'])) {
      $button = $form_state['buttons']['submit'][0];
      $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'];
    }
    // After handling the special IE case, we no longer need the buttons collection.
    unset($form_state['buttons']);
  }
913 914
}

915
/**
Dries's avatar
Dries committed
916
 * Use this function to make changes to form values in the form validate
917
 * phase, so they will be available in the submit phase in $form_state.
918 919 920
 *
 * Specifically, if $form['#parents'] is array('foo', 'bar')
 * and $value is 'baz' then this function will make
Dries's avatar
Dries committed
921
 * $form_values['foo']['bar'] to be 'baz'.
922 923 924 925 926 927
 *
 * @param $form
 *   The form item. Keys used: #parents, #value
 * @param $value
 *   The value for the form item.
 */
928 929
function form_set_value($form, $value, &$form_state) {
  _form_set_value($form_state['values'], $form, $form['#parents'], $value);
930 931 932 933 934
}

/**
 * Helper function for form_set_value().
 *
935 936
 * We iterate over $parents and create nested arrays for them
 * in $form_values if needed. Then we insert the value into
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
 * 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);
  }
}

952 953 954
/**
 * Retrieve the default properties for the defined element type.
 */
955
function _element_info($type, $refresh = NULL) {
956
  static $cache;
957

958
  $basic_defaults = array(
959 960 961
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
962
    '#tree' => FALSE,
963
    '#parents' => array()
964
  );
965
  if (!isset($cache) || $refresh) {
966 967 968
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
969
      if (isset($elements) && is_array($elements)) {
970
        $cache = array_merge_recursive($cache, $elements);
971 972 973 974
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
975
        $cache[$element_type] = array_merge_recursive($basic_defaults, $info);
976 977 978 979 980 981 982
      }
    }
  }

  return $cache[$type];
}

983 984 985 986 987 988 989 990
function form_options_flatten($array, $reset = TRUE) {
  static $return;

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

  foreach ($array as $key => $value) {
991 992 993 994
    if (is_object($value)) {
      form_options_flatten($value->option, FALSE);
    }
    else if (is_array($value)) {
995 996 997 998 999 1000 1001 1002 1003 1004
      form_options_flatten($value, FALSE);
    }
    else {
      $return[$key] = 1;
    }
  }

  return $return;
}

1005 1006 1007 1008 1009
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1010
 *   Properties used: title, value, options, description, extra, multiple, required
1011 1012 1013 1014 1015 1016 1017 1018 1019
 * @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 = '';
1020
  $size = $element['#size'] ? ' size="'. $element['#size'] .'"' : '';
1021
  _form_set_class($element, array('form-select'));
1022
  $multiple = $element['#multiple'];
1023
  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>');
1024 1025 1026 1027 1028 1029
}

function form_select_options($element, $choices = NULL) {
  if (!isset($choices)) {
    $choices = $element['#options'];
  }
1030
  // array_key_exists() accommodates the rare event where $element['#value'] is NULL.
1031 1032 1033
  // isset() fails in this situation.
  $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  $value_is_array = is_array($element['#value']);
1034 1035
  $options = '';
  foreach ($choices as $key => $choice) {
1036
    if (is_array($choice)) {
1037 1038 1039
      $options .= '<optgroup label="'. $key .'">';
      $options .= form_select_options($element, $choice);
      $options .= '</optgroup>';
1040
    }
1041 1042 1043
    elseif (is_object($choice)) {
      $options .= form_select_options($element, $choice->option);
    }
1044
    else {
1045
      $key = (string)$key;
1046
      if ($value_valid && (!$value_is_array && (string)$element['#value'] === $key || ($value_is_array && in_array($key, $element['#value'])))) {
1047 1048 1049 1050 1051
        $selected = ' selected="selected"';
      }
      else {
        $selected = '';
      }
1052
      $options .= '<option value="'. $key .'"'. $selected .'>'. check_plain($choice) .'</option>';
1053 1054
    }
  }
1055
  return $options;
1056 1057
}

1058
/**
1059 1060 1061 1062
 * Traverses a select element's #option array looking for any values
 * that hold the given key. Returns an array of indexes that match.
 *
 * This function is useful if you need to modify the options that are
1063
 * already in a form element; for example, to remove choices which are
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
 * not valid because of additional filters imposed by another module.
 * One example might be altering the choices in a taxonomy selector.
 * To correctly handle the case of a multiple hierarchy taxonomy,
 * #options arrays can now hold an array of objects, instead of a
 * direct mapping of keys to labels, so that multiple choices in the
 * selector can have the same key (and label). This makes it difficult
 * to manipulate directly, which is why this helper function exists.
 *
 * This function does not support optgroups (when the elements of the
 * #options array are themselves arrays), and will return FALSE if
 * arrays are found. The caller must either flatten/restore or
 * manually do their manipulations in this case, since returning the
 * index is not sufficient, and supporting this would make the
 * "helper" too complicated and cumbersome to be of any help.
 *
 * As usual with functions that can return array() or FALSE, do not
 * forget to use === and !== if needed.
1081 1082
 *
 * @param $element
1083
 *   The select element to search.
1084 1085 1086
 * @param $key
 *   The key to look for.
 * @return
1087 1088
 *   An array of indexes that match the given $key. Array will be
 *   empty if no elements were found. FALSE if optgroups were found.
1089
 */
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
function form_get_options($element, $key) {
  $keys = array();
  foreach ($element['#options'] as $index => $choice) {
    if (is_array($choice)) {
      return FALSE;
    }
    else if (is_object($choice)) {
      if (isset($choice->option[$key])) {
        $keys[] = $index;
      }
    }
    else if ($index == $key) {
      $keys[] = $index;
1103 1104
    }
  }
1105
  return $keys;
1106 1107
}

1108 1109 1110 1111 1112
/**
 * Format a group of form items.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1113
 *   Properties used: attributes, title, value, description, children, collapsible, collapsed
1114 1115 1116 1117
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_fieldset($element) {
1118
  if ($element['#collapsible']) {
1119 1120
    drupal_add_js('misc/collapse.js');

1121 1122 1123 1124
    if (!isset($element['#attributes']['class'])) {
      $element['#attributes']['class'] = '';
    }

1125 1126 1127
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
1128 1129 1130
    }
  }

1131
  return '<fieldset'. drupal_attributes($element['#attributes']) .'>'. ($element['#title'] ? '<legend>'. $element['#title'] .'</legend>' : '') . (isset($element['#description']) && $element['#description'] ? '<div class="description">'. $element['#description'] .'</div>' : '') . (!empty($element['#children']) ? $element['#children'] : '') . $element['#value'] ."</fieldset>\n";
1132 1133 1134 1135 1136 1137 1138
}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1139
 *   Properties used: required, return_value, value, attributes, title, description
1140 1141 1142 1143
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
1144
  _form_set_class($element, array('form-radio'));
1145
  $output = '<input type="radio" ';
1146
  $output .= 'name="'. $element['#name'] .'" ';
1147 1148 1149 1150 1151
  $output .= 'value="'. $element['#return_value'] .'" ';
  $output .= ($element['#value'] == $element['#return_value']) ? ' checked="checked" ' : ' ';
  $output .= drupal_attributes($element['#attributes']) .' />';
  if (!is_null($element['#title'])) {
    $output = '<label class="option">'. $output .' '. $element['#title'] .'</label>';
1152
  }
1153 1154 1155

  unset($element['#title']);
  return theme('form_element', $element, $output);
1156 1157 1158 1159 1160 1161 1162
}

/**
 * Format a set of radio buttons.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1163
 *   Properties used: title, value, options, description, required and attributes.
1164 1165 1166 1167
 * @return
 *   A themed HTML string representing the radio button set.
 */
function theme_radios($element) {
1168 1169 1170 1171
  $class = 'form-radios';
  if (isset($element['#attributes']['class'])) {
    $class .= ' '. $element['#attributes']['class'];
  }
1172
  $element['#children'] = '<div class="'. $class .'">'. (!empty($element['#children']) ? $element['#children'] : '') .'</div>';
1173
  if ($element['#title'] || $element['#description']) {
1174 1175
    unset($element['#id']);
    return theme('form_element', $element, $element['#children']);
1176 1177
  }
  else {
1178
    return $element['#children'];
1179 1180 1181
  }
}

1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
/**
 * Format a password_confirm item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used: title, value, id, required, error.
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_password_confirm($element) {
Dries's avatar
Dries committed
1192
  return theme('form_element', $element, $element['#children']);
1193 1194
}

1195 1196 1197 1198
/*
 * Expand a password_confirm field into two text boxes.
 */
function expand_password_confirm($element) {
Dries's avatar
Dries committed
1199 1200 1201
  $element['pass1'] =  array(
    '#type' => 'password',
    '#title' => t('Password'),
1202
    '#value' => empty($element['#value']) ? NULL : $element['#value']['pass1'],
1203
    '#required' => $element['#required'],
Dries's avatar
Dries committed
1204 1205 1206 1207
  );
  $element['pass2'] =  array(
    '#type' => 'password',
    '#title' => t('Confirm password'),
1208
    '#value' => empty($element['#value']) ? NULL : $element['#value']['pass2'],
1209
    '#required' => $element['#required'],
Dries's avatar
Dries committed
1210
  );
1211
  $element['#element_validate'] = array('password_confirm_validate');
1212 1213
  $element['#tree'] = TRUE;

1214 1215 1216 1217
  if (isset($element['#size'])) {
    $element['pass1']['#size'] = $element['pass2']['#size'] = $element['#size'];
  }

1218 1219 1220
  return $element;
}

1221
/**
1222
 * Validate password_confirm element.
1223
 */
1224
function password_confirm_validate($form, &$form_state) {
1225 1226
  $pass1 = trim($form['pass1']['#value']);
  if (!empty($pass1)) {
1227
    $pass2 = trim($form['pass2']['#value']);
1228
    if ($pass1 != $pass2) {
1229
      form_error($form, t('The specified passwords do not match.'));
1230
    }
1231
  }
1232
  elseif ($form['#required'] && !empty($form['#post'])) {
1233
    form_error($form, t('Password field is required.'));
1234
  }
1235

1236 1237
  // Password field must be converted from a two-element array into a single
  // string regardless of validation results.
1238 1239 1240
  form_set_value($form['pass1'], NULL, $form_state);
  form_set_value($form['pass2'], NULL, $form_state);
  form_set_value($form, $pass1, $form_state);
1241

1242
  return $form;
1243

1244 1245
}

1246
/**
1247
 * Format a date selection element.
1248 1249 1250
 *
 * @param $element
 *   An associative array containing the properties of the element.
1251
 *   Properties used: title, value, options, description, required and attributes.
1252
 * @return
1253
 *   A themed HTML string representing the date selection boxes.
1254 1255
 */
function theme_date($element) {
1256
  return theme('form_element', $element, '<div class="container-inline">'. $element['#children'] .'</div>');
1257 1258 1259
}

/**
1260
 * Roll out a single date element.
1261 1262 1263
 */
function expand_date($element) {
  // Default to current date
1264
  if (empty($element['#value'])) {
1265
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
1266 1267 1268 1269
                            'month' => format_date(time(), 'custom', 'n'),
                            'year' => format_date(time(), 'custom', 'Y'