WEB制作のための情報サイト / unazuki Library

get_search_query()

基本構文と使い方(引数・実行結果)

基本構文

検索キーワードを取得します。ユーザーが検索フォームで入力したキーワードを検索結果ページで表示したい場合に使えます。

get_search_query($escaped)

引数

引数必須/任意引数に指定するもの
第1引数
$escaped
任意戻り値をエスケープする場合true、しない場合false
初期値true (エスケープする)

実行結果

戻り値(返す値):検索キーワード
※表示するにはechoします。

例1.検索結果ページにて検索キーワードを表示する

下記コードをsearch.php(検索結果を表示するテンプレートファイル)に記述すると、ユーザーが検索フォームに入力した検索キーワードを表示します。

<?php echo get_search_query() ?>

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
get_post_type() 記事が所属する投稿タイプの名前を返す。
get_queried_object_id() 現在のクエリ(DBへの問い合わせ条件)に関するオブジェクトのIDを返す。
get_queried_object() 現在のクエリ(DBへの問い合わせ条件)に関するオブジェクトを返します。
the_posts_pagination() アーカイブページ(記事一覧ページ)にてページネーションを表示します。
get_the_posts_pagination() アーカイブページ(記事一覧ページ)にて利用可能なページネーションを取得します。
get_posts() 指定した条件にマッチする記事オブジェクトの配列を取得する。
get_post() 指定した投稿情報を取得する。
wp_reset_postdata() サブクエリによって上書きされたグローバルオブジェクト$postをリセットしてメインクエリに戻します。
the_post() 処理対象の記事をセットします。
have_posts() 記事が存在するかどうか調べて真偽値を返します。