function views_exposed_form

Form builder for the exposed widgets form.

Be sure that $view and $display are references.

1 string reference to 'views_exposed_form'
views_plugin_exposed_form::render_exposed_form in plugins/views_plugin_exposed_form.inc
Render the exposed filter form.

File

./views.module, line 2117

Code

function views_exposed_form($form, &$form_state) {
    // Make sure that we validate because this form might be submitted
    // multiple times per page.
    $form_state['must_validate'] = TRUE;
    $view =& $form_state['view'];
    $display =& $form_state['display'];
    $form_state['input'] = $view->get_exposed_input();
    // Let form plugins know this is for exposed widgets.
    $form_state['exposed'] = TRUE;
    // Check if the form was already created.
    if ($cache = views_exposed_form_cache($view->name, $view->current_display)) {
        return $cache;
    }
    $form['#info'] = array();
    if (!variable_get('clean_url', FALSE)) {
        $form['q'] = array(
            '#type' => 'hidden',
            '#value' => $view->get_url(),
        );
    }
    // Go through each handler and let it generate its exposed widget.
    foreach ($view->display_handler->handlers as $type => $value) {
        foreach ($view->{$type} as $id => $handler) {
            if ($handler->can_expose() && $handler->is_exposed()) {
                // Grouped exposed filters have their own forms.
                // Instead of render the standard exposed form, a new Select or
                // Radio form field is rendered with the available groups.
                // When an user choose an option the selected value is split
                // into the operator and value that the item represents.
                if ($handler->is_a_group()) {
                    $handler->group_form($form, $form_state);
                    $id = $handler->options['group_info']['identifier'];
                }
                else {
                    $handler->exposed_form($form, $form_state);
                }
                if ($info = $handler->exposed_info()) {
                    $form['#info']["{$type}-{$id}"] = $info;
                }
            }
        }
    }
    // Form submit, #name is an empty string to prevent showing up in $_GET.
    $form['submit'] = array(
        '#name' => '',
        '#type' => 'submit',
        '#value' => t('Apply'),
        '#id' => drupal_html_id('edit-submit-' . $view->name),
    );
    $form['#action'] = url($view->display_handler
        ->get_url());
    $form['#theme'] = views_theme_functions('views_exposed_form', $view, $display);
    $form['#id'] = drupal_clean_css_identifier('views_exposed_form-' . check_plain($view->name) . '-' . check_plain($display->id));
    // If using AJAX, we need the form plugin.
    if ($view->use_ajax) {
        drupal_add_library('system', 'jquery.form');
    }
    ctools_include('dependent');
    $exposed_form_plugin = $form_state['exposed_form_plugin'];
    $exposed_form_plugin->exposed_form_alter($form, $form_state);
    // Save the form.
    views_exposed_form_cache($view->name, $view->current_display, $form);
    return $form;
}