説明
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
関連
お勧め
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する（2012年3月15日 更新）
投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える（2014年9月12日 更新）
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。