当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/get search form」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(最新英語版を反映。一部未翻訳です。)
(Return Values)
16行目: 16行目:
  
 
<div id="Return Values">
 
<div id="Return Values">
==Return Values==
+
==戻り値==
 
; (string) : The form's HTML, if the $echo parameter is set to false.
 
; (string) : The form's HTML, if the $echo parameter is set to false.
 
</div>
 
</div>
  
 
<div id="Examples">
 
<div id="Examples">
 +
 
==用例==
 
==用例==
 
テーマに <tt>searchform.php</tt> が無い場合は、WordPress はビルトインの検索フォームを表示します。
 
テーマに <tt>searchform.php</tt> が無い場合は、WordPress はビルトインの検索フォームを表示します。

2015年5月1日 (金) 21:55時点における版

このページ「関数リファレンス/get search form」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

説明

テーマの searchform.php を使用して検索フォームを表示します。

使い方

<?php get_search_form( $echo ); ?>

パラメータ

$echo
boolean) (optional) true to echo the form; false to return the form as a string
初期値: True

戻り値

(string) 
The form's HTML, if the $echo parameter is set to false.

用例

テーマに 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>

テーマに searchform.php がある場合は、それを使用します。検索フォームは、ブログのホームページに GET を投げることに注意してください。入力テキストフィールドの名前は s にして、上述の例のように label を必ず含めてください。

以下は、カスタム searchform.php の例です。

<form action="/" method="get">
    <fieldset>
        <label for="search">Search in <?php bloginfo( 'name' ); ?></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>

(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' );

注意点

The $echo parameter is ignored when searchform.php is present. There is a issue in the WordPress Trac concerning this.

A workaround is to pass the form to get_search_form() through the get_search_form filter.

変更履歴

2.7.0 で新規追加。

ソースファイル

get_search_form()wp-includes/general-template.php に含まれる。

最新英語版: WordPress Codex » Function Reference/get search form最新版との差分