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

説明

the_search_query() は、検索キーワードを、エスケープして出力する関数です。

基本構文

the_search_query(): void

引数

引数はありません。

戻り値

戻り値はありません。検索キーワードを出力します。

使い方(サンプル)

<input type="search" name="s" value="<?php the_search_query(); ?>">

注意点

  • 属性値の中で使える形に、エスケープして出力されます。
  • 検索結果ページ以外では、空になります。

実務での使いどころ

  • 検索フォームに、検索したキーワードを引き継ぐとき。
  • 検索結果の見出しに、キーワードを出すとき。

よくあるミスと対処

  • 値として使いたいのに、これを使っている。値は get_search_query() で取得する。
  • esc_html( the_search_query() ) のように、値として使う。この関数は、出力するだけで、値を返さない。

NG例

echo esc_html( the_search_query() ); // すでに出力される関数で、値は返らない

OK例

the_search_query();

使い分け早見表

関数 役割
the_search_query() キーワードを出力する(エスケープ済み)
get_search_query() キーワードを、文字列で取得する
get_search_link() 検索結果ページのURLを取得する

関連項目

get_search_query()、get_search_link()、is_search()

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

コメント

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