get_search_form

（2.7.0以降）
get_search_form - 検索フォームを読み込む

説明

void get_search_form( [ bool $echo = true ] )
サイト内検索フォームのテンプレートファイルを読み込んで表示する。

パラメータ

  • $echo
    [3.0.0]表示する場合はtrue、内容を取得する場合はfalseを指定（省略時はtrue）

返り値

パラメータ$echoがfalseの場合は検索フォームのHTMLを返す。パラメータ$echoがtrueの場合は返り値はありません。

注意

テーマ内の検索フォームテンプレートファイルsearchform.phpが存在しない場合は、WordPress標準の検索フォームが表示される。

使用例

  • テーマ内の検索フォームテンプレートファイルsearchform.phpを読み込む。
    <?php get_search_form( ); ?>

フィルター

[3.6.0]'search_form_format'フィルターを呼び出す。パラメータ$formatはHTMLフォーマットの内容として'html5'または'xhtml'が格納されている。 
$format = apply_filters( 'search_form_format', $format );
[2.7.0]表示または値を返す直前に'get_search_form'フィルターを呼び出す。パラメータ$formには検索フォームのHTMLが格納されている。 
$result = apply_filters( 'get_search_form', $form );

アクション

[3.6.0]はじめにpre_get_search_formアクションを呼び出す。 
do_action( 'pre_get_search_form' );

ソースファイル

/wp-includes/general-template.php

最終更新 : 2018年05月27日 10:47

関連

参考

Code Reference: get_search_form

お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

WordPressの鼓動（2013年10月1日 更新）

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

Gutenberg、「More」の翻訳は「続きを読む」？（2018年8月15日 更新）

Gutenbergの新エディターを使用中、ボタン上にポインタを移動させると「続きを読む」と表示されるところが複数あった。なぜ、ここが「続きを読む」なのか疑問に思ったので、少し調べてみた。

the_date関数で投稿日を確実に表示する（2011年12月20日 更新）

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

HTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。