get_search_form


get_search_form ( $echo = true )

Parameters:
  • (bool) $echo Default to echo and not return the form.
Returns:
  • (string|void) String when $echo is false.
Defined at:

Description

Display search form.

Will first attempt to locate the searchform.php file in either the child or the parent, then load it. If it doesn't exist, then the default search form will be displayed. The default search form is HTML, which will be displayed. There is a filter applied to the search form HTML in order to edit or replace it. The filter is {@see 'get_search_form'}.

This function is primarily used by themes which want to hardcode the search form into the sidebar and also by the search widget in WordPress.

There is also an action that is called whenever the function is run called, {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the search relies on or various formatting that applies to the beginning of the search. To give a few examples of what it can be used for.

Related Functions

get_search_query, install_search_form, get_search_link, get_search_template, get_search_feed_link

Top Google Results

User discussions

wpseek mobile