説明
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, $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
関連
お勧め
Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
さくらのVPSでKUSANAGI（2018年5月27日 更新）
請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。
ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）
ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。
各投稿記事で設定されているカスタムフィールドの値を取得するには（2011年9月16日 更新）
投稿記事ごとに設定されているカスタムフィールドの値は get_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。