get_search_form

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

説明

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

パラメータ

  • $echo
    [5.2.0]キー'echo'で表示指定を、キー'aria_label'でform要素のaria-label属性値を格納した連想配列を指定（省略時はarray()）
    [3.0.0]表示する場合はtrue、内容を取得する場合はfalseを指定（省略時はtrue）

返り値

[5.2.0]パラメータ$argsがfalseかキー'echo'の場合は検索フォームのHTMLを返す。それ以外は返り値はありません。
[3.0.0]パラメータ$echoがfalseの場合は検索フォームのHTMLを返す。パラメータ$echoがtrueの場合は返り値はありません。

注意

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

[5.2.0]パラメータが表示を指定するbool値から連想配列に変更され、既定値とマージされて使用される。

キー$argsがtrue$argsがfalse$argsがarray( 'aria_label' => 'Search' )
'echo'truefalsetrue
'aria_label''''''Search'

使用例

  • 検索フォームテンプレートファイルsearchform.phpを出力する。
    <?php get_search_form( ); ?>

フィルター

[5.2.0]'search_form_args'フィルターを呼び出す。パラメータ$argsには受け取った内容を既定値とマージした内容が格納されている。 
$args = apply_filters( 'search_form_args', $args );
[3.6.0]'search_form_format'フィルターを呼び出す。パラメータ$formatはHTMLフォーマットの内容として'html5'または'xhtml'が格納されている。[5.5.0]パラメータ$argsが追加され、本関数が受け取った内容が格納されている。 
$format = apply_filters( 'search_form_format', $format, $args );
[2.7.0]表示または値を返す直前に'get_search_form'フィルターを呼び出す。パラメータ$formには検索フォームのHTMLが格納されている。[5.5.0]パラメータ$argsが追加され、本関数が受け取った内容が格納されている。 
$result = apply_filters( 'get_search_form', $form, $args );

アクション

[3.6.0]はじめにpre_get_search_formアクションを呼び出す。[5.5.0]パラメータ$argsが追加され、本関数が受け取った内容が格納されている。 
do_action( 'pre_get_search_form', $args );

ソースファイル

/wp-includes/general-template.php

最終更新 : 2020年08月18日 11:40

関連

参考

Code Reference: get_search_form

お勧め

囲み型ショートコードとwpautop（2018年5月27日 更新）

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

使っていないか確認しないとね！（フィルター編）（2019年4月24日 更新）

先週末にWordPress 5.2 Beta3（以降5.2Beta3）が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.5.0の新機能紹介（2018年12月10日 更新）

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

時代はWP_Queryなのか（2011年8月1日 更新）

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

query_posts（WP_Queryクラス）で'tax_query'を使いこなす（2011年9月14日 更新）

2日にわたって投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」「query_posts（WP_Queryクラス）で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。