shopp('storefront.search-form')

Displays a product search form.

shopp('storefront', 'search-form', 'options')

@param string $object the object or object.tag combination, if object.tag is used, the tag parameter can be omitted
@param string $tag the tag, can be hyphenated or not. Prefix with 'get' as shorthand for the return=true option
@param mixed $options associative array, or url-style name=value pairs separated by ampersands (&). Each pair is passed to the theme api tag as an option.
@returns string Markup for the search form

Outputs markup for a product search form. This call uses the WordPress get_search_form() function call to get the generated search form to get the primary markup. A hidden input is added into the contents of the <form> element in order to flag the search as a Shopp catalog search. Without the flag, any searches through the form will perform a standard WordPress content search.

The actual markup for the search form is derived from the active WordPress theme’s searchform.php theme template file. If no searchform.php theme template file exists in the active theme (child or parent) the markup is set to a preset value built into the WordPress core:

<form role="search" method="get" id="searchform" action="' . esc_url( home_url( '/' ) ) . '" >
    <div><label class="screen-reader-text" for="s">' . __('Search for:') . '</label>
    <input type="text" value="' . get_search_query() . '" name="s" id="s" />
    <input type="submit" id="searchsubmit" value="'. esc_attr__('Search') .'" />
    </div>
</form>

Options

Universal Options

All Theme API calls have these options.

  • return: when set to true, 1, or on, this option forces the tag to return the value instead of displaying/echoing the value to the page. Alternatively, prefix the tag parameter with get to get the same effect. All theme api tags that return a boolean value will return by default.
  • echo: when set to false, 0, or off, this option forces the tag to display the value to the page. This is the default for all non-boolean tags.
  • is: when set to true, 1, or on, this option will evaluate the return of the theme api call as a boolean true or false value. See how values are converted to boolean.

Alternative Forms

shopp('storefront.search-form', 'options');

Examples

shopp('storefront.search-form');

See Also

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.

Skip to toolbar