Home › API reference › search.module

search_box

  1. drupal
    1. 4.7
    2. 5 search.module
    3. 6 search.module
    4. 7 search.module
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)

Output a search form for the search block and the theme's search box.

Related topics

Search interface
The Drupal search interface manages a global search mechanism.

▸ 2 functions call search_box()

▾ 2 functions call search_box()

phptemplate_page in themes/engines/phptemplate/phptemplate.engine
Prepare the values passed to the theme_page function to be passed into a pluggable template engine.
search_block in modules/search.module
Implementation of hook_block().

Code

modules/search.module, line 1029

<?php
function search_box($form_id = 'search_theme_form') {
  // Use search_keys instead of keys to avoid ID conflicts with the search block.
  $form[$form_id . '_keys'] = array(
    '#type' => 'textfield', 
    '#size' => 15, 
    '#default_value' => '', 
    '#attributes' => array('title' => t('Enter the terms you wish to search for.')),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Search'),
  );
  // Always go to the search page since the search form is not guaranteed to be
  // on every page.
  $form['#action'] = url('search/node');

  return drupal_get_form($form_id, $form, 'search_box_form');
}
?>