search-block-form.tpl.php
Displays the search form block.
Available variables:
- $search_form: The complete search form ready for print.
- $search: Associative array of search elements. Can be used to print each form element separately.
Default elements within $search:
- $search['search_block_form']: Text input area wrapped in a div.
- $search['actions']: Rendered form buttons.
- $search['hidden']: Hidden form elements. Used to validate forms when submitted.
Modules can add to the search form, so it is recommended to check for their existence before printing. The default keys will always exist. To check for a module-provided field, use code like this:
<?php if (isset($search['extra_field'])): ?>
<div class="extra-field">
<?php print $search['extra_field']; ?>
</div>
<?php endif; ?>
See also
template_preprocess_search_block_form()
File
-
modules/
search/ search-block-form.tpl.php
View source
<?php
/**
* @file
* Displays the search form block.
*
* Available variables:
* - $search_form: The complete search form ready for print.
* - $search: Associative array of search elements. Can be used to print each
* form element separately.
*
* Default elements within $search:
* - $search['search_block_form']: Text input area wrapped in a div.
* - $search['actions']: Rendered form buttons.
* - $search['hidden']: Hidden form elements. Used to validate forms when
* submitted.
*
* Modules can add to the search form, so it is recommended to check for their
* existence before printing. The default keys will always exist. To check for
* a module-provided field, use code like this:
* @code
* <?php if (isset($search['extra_field'])): ?>
* <div class="extra-field">
* <?php print $search['extra_field']; ?>
* </div>
* <?php endif; ?>
* @endcode
*
* @see template_preprocess_search_block_form()
*/
?>
<div class="container-inline">
<?php
if (empty($variables['form']['#block']->subject)) {
?>
<h2 class="element-invisible"><?php
print t('Search form');
?></h2>
<?php
}
?>
<?php
print $search_form;
?>
</div>
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.