Search input

On this page:

Syntax

<txp:search_input />

The search_input tag is a single tag. This tag will provide a text entry field for search parameters and an optional button to initiate the search.

Attributes

Tag will accept the following attributes (case-sensitive):

button="text"
Creates and labels a button to initiate the search.
Default: unset (no button is created).
form="form name"
Use specified form template to build a customized HTML form.
Default: search_input.
html_id="id" v4.0.7+
The HTML id attribute assigned to the search form.
Default: unset.
match="match type" v4.3.0+
Set the search mode. Choose from:
exact: search terms must exactly match the words in the article in the order given. This mode is also automatically selected if the search term is surrounded with double quotes.
any: any of the search terms in an article will cause it to show up in the results.
all: all of the search terms in the article must exist (in any order) for the article to be included in the results.
Default exact.
section="section name"
Use the specified section as the destination page that will display the search results.
Default: unset (use the front page).
size="integer"
Sets the size attribute of the search input field.
Default: 15.

Common presentational attributes

These attributes, which affect presentation, are shared by many tags. Note that default values can vary among tags.

class="class name"
HTML class to apply to the wraptag attribute value.
Default: tag name or unset (see class cross-reference).
label="text"
Label prepended to item.
Default: unset (but see label cross-reference for exceptions).
wraptag="element"
HTML element to wrap markup, specified without brackets (e.g. wraptag="div").
Default: unset (but see wraptag cross-reference for exceptions).

Examples

Example 1: Display a search input form

<txp:search_input label="Search" button="Search" size="20" wraptag="div" />

Example 2: Elements required for building a customized HTML search form

You can build your own custom search form by specifying form="form-name" inside the <txp:search_input /> tag:

<txp:search_input form="form-name" />

You would then need to build your Form (i.e. form-name), and the absolute minimum Textpattern tags and attributes required would be:

<form action="<txp:site_url />">
    <input name="q" type="search" />
</form>

When using a customized form template, Textpattern doesn’t automatically wrap the HTML form output with <form> tags, thus you need the opening and closing <form> tag pair. The name="q" attribute and value is required to initiate a search query.

Other tags used: site_url.

Note: Textpattern will use a user defined form named search_results, or an internally defined default form if no search result form is defined by you.

Genealogy

Version 4.3.0

match attribute added.

Version 4.0.7

html_id attribute added.

See something wrong in this document? Outdated info, a broken link, faulty code example, or whatever? Please write an issue and we’ll fix it.