function form_type_password_confirm_value

Determines the value for a password_confirm form element.

Parameters

$element: The form element whose value is being populated.

$input: The incoming input to populate the form element. If this is FALSE, the element's default value should be returned.

Return value

The data that will appear in $form_state['values'] for this element, or nothing to use the default.

Related topics

File

includes/form.inc, line 2519

Code

function form_type_password_confirm_value($element, $input = FALSE) {
    if ($input === FALSE) {
        $element += array(
            '#default_value' => array(),
        );
        return $element['#default_value'] + array(
            'pass1' => '',
            'pass2' => '',
        );
    }
    $value = array(
        'pass1' => '',
        'pass2' => '',
    );
    // Throw out all invalid array keys; we only allow pass1 and pass2.
    foreach ($value as $allowed_key => $default) {
        // These should be strings, but allow other scalars since they might be
        // valid input in programmatic form submissions. Any nested array values
        // are ignored.
        if (isset($input[$allowed_key]) && is_scalar($input[$allowed_key])) {
            $value[$allowed_key] = (string) $input[$allowed_key];
        }
    }
    return $value;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.