説明
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' | true | false | true |
| 'aria_label' | '' | '' | 'Search' |
使用例
- 検索フォームテンプレートファイルsearchform.phpを出力する。<?php get_search_form( ); ?>
フィルター
[5.2.0]'search_form_args'フィルターを呼び出す。パラメータ$argsには受け取った内容を既定値とマージした内容が格納されている。$args = apply_filters( 'search_form_args', $args );$format = apply_filters( 'search_form_format', $format );$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最終更新 : 2019年05月09日 14:34
関連
お勧め
サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。任意の名前でエラーログファイルを指定する（2019年2月15日 更新）
来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。
カレンダーウィジェットをAjaxで切り替える（2011年8月22日 更新）
ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。管理画面でよく使うスタイルをまとめてみた「メッセージ編」（2019年7月30日 更新）
標準で用意されているスタイルを知っておくことで、独自に用意するスタイルを軽減でき、機能拡張した部分の見た目は違和感が少なくなる。そんな共通要素のスタイルのひとつが「メッセージ」だ。メッセージにはいくつかの意味合いがあり、用途に応じてすぐに使い分けすることになる。今回はそんなメッセージ向けのスタイルをざっくりまとめてみた。