search-theme-form.tpl.php

You are here

search-theme-form.tpl.php Default theme implementation for displaying a search form directly into the theme layout. Not to be confused with the search block or the search page.

Available variables:

  • $search_form: The complete search form ready for print.
  • $search: Array of keyed search elements. Can be used to print each form element separately.

Default keys within $search:

  • $search['search_theme_form']: Text input area wrapped in a div.
  • $search['submit']: Form submit button.
  • $search['hidden']: Hidden form elements. Used to validate forms when submitted.

Since $search is keyed, a direct print of the form element is possible. Modules can add to the search form so it is recommended to check for their existance before printing. The default keys will always exist.

<?php if (isset($search['extra_field'])): ?> <div class="extra-field"> <?php print $search['extra_field']; ?> </div> <?php endif; ?>

To check for all available data within $search, use the code below.

<?php print '<pre>'. check_plain(print_r($search, 1)) .'</pre>'; ?>

See also

template_preprocess_search_theme_form()

File

modules/search/search-theme-form.tpl.php
View source
  1. <?php
  2. /**
  3. * @file search-theme-form.tpl.php
  4. * Default theme implementation for displaying a search form directly into the
  5. * theme layout. Not to be confused with the search block or the search page.
  6. *
  7. * Available variables:
  8. * - $search_form: The complete search form ready for print.
  9. * - $search: Array of keyed search elements. Can be used to print each form
  10. * element separately.
  11. *
  12. * Default keys within $search:
  13. * - $search['search_theme_form']: Text input area wrapped in a div.
  14. * - $search['submit']: Form submit button.
  15. * - $search['hidden']: Hidden form elements. Used to validate forms when submitted.
  16. *
  17. * Since $search is keyed, a direct print of the form element is possible.
  18. * Modules can add to the search form so it is recommended to check for their
  19. * existance before printing. The default keys will always exist.
  20. *
  21. * <?php if (isset($search['extra_field'])): ?>
  22. * <div class="extra-field">
  23. * <?php print $search['extra_field']; ?>
  24. * </div>
  25. * <?php endif; ?>
  26. *
  27. * To check for all available data within $search, use the code below.
  28. *
  29. * <?php print '<pre>'. check_plain(print_r($search, 1)) .'</pre>'; ?>
  30. *
  31. * @see template_preprocess_search_theme_form()
  32. */
  33. ?>
  34. <div id="search" class="container-inline">
  35. <?php print $search_form; ?>
  36. </div>

Comments

For drupal 7 see search-block-form.tpl.php