Home › API reference › search.module

search_box

  1. drupal
    1. 4.7 search.module
    2. 5 search.module
    3. 6
    4. 7
Versions
4.7 search_box($form_id = 'search_theme_form')
5 search_box($form_id)
6 search_box(&$form_state, $form_id)
7 search_box($form, &$form_state, $form_id)

Form builder; Output a search form for the search block's search box.

See also

search_box_form_submit()

search-theme-form.tpl.php

search-block-form.tpl.php

Related topics

Search interface
The Drupal search interface manages a global search mechanism.
Form builder functions
Functions that build an abstract representation of a HTML form.

Code

drupal/modules/search/search.module, line 1011

<?php
function search_box($form, &$form_state, $form_id) {
  $form[$form_id] = array(
    '#type' => 'textfield', 
    '#title' => t('Search'), 
    '#title_display' => 'invisible', 
    '#size' => 15, 
    '#default_value' => '', 
    '#attributes' => array('title' => t('Enter the terms you wish to search for.')),
  );
  $form['actions'] = array('#type' => 'actions');
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Search'),
  );
  $form['#submit'][] = 'search_box_form_submit';

  return $form;
}
?>