WordPress как на ладони
wordpress jino

get_search_form() WP 2.7.0

Подключает форму поиска, файл темы searchform.php. Если такого файла в шаблоне темы нет, то будет использован дефолтный код для формы поиска.

Хуки из функции:

Использование

<?php get_search_form(); ?>

Примеры

#1. HTML формы поиска через файл searchform.php

Создаем файл searchform.php в папке темы с кодом:

<form role="search" method="get" id="searchform" action="<?php echo home_url( '/' ) ?>" >
	<label class="screen-reader-text" for="s">Поиск: </label>
	<input type="text" value="<?php echo get_search_query() ?>" name="s" id="s" />
	<input type="submit" id="searchsubmit" value="найти" />
</form>

Затем, там где нужна форма поиска, вызываем функцию get_search_form(), которая выведет содержимое созданного нами файла searchform.php:

<?php get_search_form(); ?>

Имейте ввиду, что форма поиска должна отправлять GET запрос на главную страницу сайта: action="<?php echo home_url( '/' ); ?>") и обязательно должен присутствовать параметр s (что искать): <input type="text" value="" name="s" id="s" />.

#1.1 HTML формы поиска по умолчанию

Если в теме нет файла searchform.php, то вызов этой функции выведет HTML формы по умолчанию:

<form role="search" method="get" id="searchform" class="searchform" action="<?php echo esc_url( home_url( '/' ) ); ?>">
	<div>
		<label class="screen-reader-text" for="s"><?php _x( 'Search for:', 'label' ); ?></label>
		<input type="text" value="<?php echo get_search_query(); ?>" name="s" id="s" />
		<input type="submit" id="searchsubmit" value="<?php echo esc_attr_x( 'Search', 'submit button' ); ?>" />
	</div>
</form>

Такая HTML разметка будет выведена если, НЕ установлена поддержка html5 в теме. Напомню, устанавливается она через функцию add_theme_support() так:

add_theme_support( 'html5', array( 'search-form' ) );

Однако, если поддержка html5 включена, то по умолчанию мы получим такой HTML код формы поиска:

<form role="search" method="get" class="search-form" action="<?php echo home_url( '/' ); ?>">
	<label>
		<span class="screen-reader-text"><?php echo _x( 'Search for:', 'label' ) ?></span>
		<input type="search" class="search-field" placeholder="<?php echo esc_attr_x( 'Search …', 'placeholder' ) ?>" value="<?php echo get_search_query() ?>" name="s" title="<?php echo esc_attr_x( 'Search for:', 'label' ) ?>" />
	</label>
	<input type="submit" class="search-submit" value="<?php echo esc_attr_x( 'Search', 'submit button' ) ?>" />
</form>

Т.е. тип поля меняется с text на search: type="search".

Предпочтение стоит отдавать html5 форме, поэтому всегда включайте эту настройку в темах!

#2. HTML формы поиска через хук

Можно не создавать файл темы searchform.php, а изменить HTML код формы через хук get_search_form, который нужно вставлять в файл темы functions.php.

add_filter( 'get_search_form', 'my_search_form' );
function my_search_form( $form ) {

	$form = '
	<form role="search" method="get" id="searchform" action="' . home_url( '/' ) . '" >
		<label class="screen-reader-text" for="s">Запрос для поиска:</label>
		<input type="text" value="' . get_search_query() . '" name="s" id="s" />
		<input type="submit" id="searchsubmit" value="Найти" />
	</form>';

	return $form;
}

#3. Фильтр (ограничение) результатов поиска

Кроме параметра запроса s, можно отфильтровать поиск по типу записи. Для этого добавьте в форму еще одно input поле с именем post_type:

<input type="hidden" value="post" name="post_type" />

В результате при сабмите мы получит строку запроса вида: ?s=текст&post_type=post. А это значит, что поиск будет проходить не по всем типам записей, а только по типу записи указанному в поле name="post_type", в данном случае по типу post. По умолчанию там указано: post_type = any (любой тип записи).

Также результаты поиска можно отфильтровать как угодно, используя событие pre_get_posts. Примеры смотрите в описании.

Заметки

Не забывайте про безопастность

В строку поиска, пользователь может вписать что угодно, например рабочий скрипт <script>alert('aaaa');<script>. И если вывести строку запроса на странице как есть, то такой скрипт будет обработан бразуером. А если в него написать что-то нехорошее, то ваш сайт можно будет легко взломать.

Поэтому для вывода запроса поиска на экран, всегда используйте функцию get_search_query(). Она обезопасит вас от XSS атак. Именно это место является одним из самых слабых в безопасности самодельных тем.

<?php echo get_search_query(); ?>

Выводимую строку также можно очистить с помощью: esc_attr(), esc_html().

Код get search form: wp-includes/general-template.php WP 4.9

<?php
function get_search_form( $echo = true ) {
	/**
	 * Fires before the search form is retrieved, at the start of get_search_form().
	 *
	 * @since 2.7.0 as 'get_search_form' action.
	 * @since 3.6.0
	 *
	 * @link https://core.trac.wordpress.org/ticket/19321
	 */
	do_action( 'pre_get_search_form' );

	$format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml';

	/**
	 * Filters the HTML format of the search form.
	 *
	 * @since 3.6.0
	 *
	 * @param string $format The type of markup to use in the search form.
	 *                       Accepts 'html5', 'xhtml'.
	 */
	$format = apply_filters( 'search_form_format', $format );

	$search_form_template = locate_template( 'searchform.php' );
	if ( '' != $search_form_template ) {
		ob_start();
		require( $search_form_template );
		$form = ob_get_clean();
	} else {
		if ( 'html5' == $format ) {
			$form = '<form role="search" method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
				<label>
					<span class="screen-reader-text">' . _x( 'Search for:', 'label' ) . '</span>
					<input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search &hellip;', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" />
				</label>
				<input type="submit" class="search-submit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />
			</form>';
		} else {
			$form = '<form role="search" method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">
				<div>
					<label class="screen-reader-text" for="s">' . _x( 'Search for:', 'label' ) . '</label>
					<input type="text" value="' . get_search_query() . '" name="s" id="s" />
					<input type="submit" id="searchsubmit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />
				</div>
			</form>';
		}
	}

	/**
	 * Filters the HTML output of the search form.
	 *
	 * @since 2.7.0
	 *
	 * @param string $form The search form HTML output.
	 */
	$result = apply_filters( 'get_search_form', $form );

	if ( null === $result )
		$result = $form;

	if ( $echo )
		echo $result;
	else
		return $result;
}

Cвязанные функции

Из раздела: Подключение файлов

get_search_form 26 комментариев
Полезные 1 Вопросы 2 Все
  • Валера

    код: pre class="php"

    Ответить4.5 года назад #
  • NurCoder cайт: akaibu.ru

    Спасибо за статью! Единственная статья, которая дала ясное представление о структуре поиска wordpress.

    3
    Ответить3.3 года назад #
  • Борис @

    Спасибо!! Сомневался, что у меня будет работать... Но всё отлично. Походил по адсенсу - в благодарность за инфу. Ломаю голову несколько дней - не подключаются скрипты и стили через function.php. Перепробовал множество предлагаемых в сети вариантов, и у Вас смотрел enqueue_script - не хотят и всё. Может знаете какую-то фичу?? Буду очень благодарен. Спасибо.

    1
    Ответить2.5 года назад #
    • Борис @

      ответ, собственно в самом вопросе: файл должен называться functions.php - вот его вордпресс и не видел. Нельзя сутки сидеть за работой!smile

      1
      Ответить2 года назад #
    • Sam Williams cайт: web-page.pw

      Так вроде - functions.php ...? У Вас function.php

      1
      Ответить1.5 года назад #
  • Вы не планируете создать урок на тему живого поиска, такого же, как на Вашем сайте?

    1
    Ответить2.1 года назад #
  • Александр

    Доброго времени суток! Помогите решить вопрос с поиском, форму настроил , поиск работает, интересует такой вариант, поиск находит 20 записей, хочу что бы отображалось допустим 5 записей, а при нажатии на кнопку "все результаты" что б отображало все 20 записей!? Спасибо заранее!

    Ответитьгод назад #
  • Юрий cайт: виртуальная-жд.рф

    Юху! У меня поиск искал с той страницы, где находишься и выдавал результаты внутри страницы, чаще всего 404.

    Решением было добавление кода:

    action="<?= home_url( '/' ) ?>"

  • Александр cайт: bong.ru/produkciya/page/17/?phpget_searc...

    Доброго времени!
    Вообщем ситуация такая, добавил сначала php get_search_form, а потом посмотрел и подумал что яндекс поиск на сайте очень даже не плох и добавил его (сгенерированный код поиска яндекс- все работает отлично), НО теперь у меня появилась куча страниц дублей с вот таким url: http://bong.ru/produkciya/page/17/?phpget_search_form; dash help посмотрел код и не понимаю вроде ?phpget_search_form нигде нет. Что может быть?? заранее спасибо.

Здравствуйте, !

Ваш комментарий