wordpress get_search_form()函数

【函数介绍】

get_search_form()用于包含主题文件下的搜索表单文件searchform.php，如果没有这个php文件则会指定调用默认的搜索表单。

【函数使用】

<?php get_search_form( $echo ); ?>

【参数说明】

$echo
(boolean) (可选) true – 直接输出搜索表单; false – 以字符串形式返回搜索表单.
默认: true

【返回值】

(string) 如果 $echo参数为false返回HTML的form表单字符串。

【函数实例】

1、如果主题目录里没有searchform.php这个文件，那么WordPress将默认使用内置的搜索表单：

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

2、如果主题文件里有searchform.php这个文件，那么WordPress就会使用指定的搜索表单模版。注意，搜索表单应该使用get方法指向主页，文本域的name应该是s。
这是一个自定义searchform.php的例子：

<form action="/" method="get">
    <fieldset>
        <label for="search">Search in <?php echo home_url( '/' ); ?></label>
        <input type="text" name="s" id="search" value="<?php the_search_query(); ?>" />
        <input type="image" alt="Search" src="<?php bloginfo( 'template_url' ); ?>/images/search.png" />
    </fieldset>
</form>

3、最后，还得在主题的functions.php文件里添加一个自定义函数，作为一个钩子与get_search_form函数连接起来，搜索表单才起作用。

function my_search_form( $form ) {

    $form = '<form role="search" method="get" id="searchform" action="' . 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>';

    return $form;
}

add_filter( 'get_search_form', 'my_search_form' );

【源代码】

get_search_form() 位于 wp-includes/general-template.php，函数代码如下：

function get_search_form($echo = true) {
	do_action( 'get_search_form' );
 
	$search_form_template = locate_template('searchform.php');
	if ( '' != $search_form_template ) {
		require($search_form_template);
		return;
	}
 
	$form = '<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>';
 
	if ( $echo )
		echo apply_filters('get_search_form', $form);
	else
		return apply_filters('get_search_form', $form);
}
?>