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

説明

get_search_link() は、サイト内検索結果のURLを返す関数です。

基本構文

get_search_link( string $query = '' ): string

引数

  • $query:検索キーワード

戻り値

検索結果のURL。

使い方(サンプル)

echo esc_url( get_search_link( 'WordPress' ) );

注意点

  • home_url( '/?s=...' ) と同じ目的で使えますが、パーマリンク設定に応じたURLを返します。

実務での使いどころ

  • 検索結果ページのURLを作るとき(キーワードを付けたリンクなど)。
  • 検索フォームの送信先を、組み立てるとき。

よくあるミスと対処

  • URLを直接組み立てている(/?s=キーワード)。パーマリンク設定によって、検索のURLの形式が違う。
  • 出力時に、esc_url() を通していない。

NG例

echo home_url( '/?s=' . $keyword ); // 形式を決め打ちしている

OK例

echo esc_url( get_search_link( $keyword ) );

使い分け早見表

関数 返すもの
get_search_link() 検索結果ページのURL
get_search_query() 検索キーワード
home_url() サイトのトップページのURL

関連項目

get_search_query()、home_url()

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

コメント

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