説明
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
関連
お勧め
Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。常時SSL接続に変更しました（2018年5月27日 更新）
先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」（CentOS 6系、Apache 2.2系）上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。
5.3の新機能：サイト管理者のメールアドレスを定期的に確認する（2019年9月27日 更新）
「WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。
5.3の新機能：JPEG画像の向きを自動調整（2019年10月17日 更新）
「WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。
投稿画面のウェジェットを2列にする（2013年4月17日 更新）
ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。