function _form_button_was_clicked

Determines if a given button triggered the form submission.

This detects button controls that trigger a form submission by being clicked and having the click processed by the browser rather than being captured by JavaScript. Essentially, it detects if the button's name and value are part of the POST data, but with extra code to deal with the convoluted way in which browsers submit data for image button clicks.

This does not detect button clicks processed by Ajax (that is done in _form_element_triggered_scripted_submission()) and it does not detect form submissions from Internet Explorer in response to an ENTER key pressed in a textfield (form_builder() has extra code for that).

Because this function contains only part of the logic needed to determine $form_state['triggering_element'], it should not be called from anywhere other than within the Form API. Form validation and submit handlers needing to know which button was clicked should get that information from $form_state['triggering_element'].

Related topics

File

includes/form.inc, line 2226

Code

function _form_button_was_clicked($element, &$form_state) {
    // 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_state['input'][$element['#name']]) && $form_state['input'][$element['#name']] == $element['#value']) {
        return TRUE;
    }
    elseif (!empty($element['#has_garbage_value']) && isset($element['#value']) && $element['#value'] !== '') {
        return TRUE;
    }
    return FALSE;
}