説明
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
関連
お勧め
xmlrpc.phpへのアクセスについてちょっと考えた（2018年5月27日 更新）
少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。
開発環境（Windows 8）にimagickを入れる（2012年12月23日 更新）
WordPress 3.5のイメージエディタ（WP_Image_Editor）は、GDだけでなく、imagick（ImageMagick）にも対応している。そんなわけでWindows 8の開発環境にimagickをインストールしてみた。Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。
タイトルのみをキーワード検索する（2014年4月3日 更新）
WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。