get_search_query() の使い方|説明・引数・注意点

説明

get_search_query() は、現在の検索キーワードを返す関数です。

基本構文

get_search_query( bool $escaped = true ): string

引数

  • $escaped:true でHTMLエスケープして返す(既定)

戻り値

検索キーワード。

使い方(サンプル)

echo esc_html( get_search_query() );

注意点

  • 既定でエスケープ済みです。esc_html() を重ねると二重エスケープになることがあります。

実務での使いどころ

  • 検索結果ページで、検索したキーワードを表示するとき。
  • 検索フォームに、キーワードを引き継ぐとき(value 属性)。

よくあるミスと対処

  • 既定でエスケープ済み($escaped が true)。さらにエスケープを重ねる必要はない(重ねても、二重にはならないが、冗長)。
  • 検索結果ページ以外では、空文字が返る。

NG例

echo esc_html( get_search_query() ); // すでにエスケープ済みで、冗長

OK例

echo get_search_query(); // エスケープ済み

使い分け早見表

関数 返すもの
get_search_query() 検索キーワード(既定でエスケープ済み)
get_search_link() 検索結果ページのURL
is_search() 検索結果ページか判定

関連項目

is_search()、the_search_query()、get_search_link()

公式リファレンス:get_search_query() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました