get_search_query

説明

string get_search_query( [ bool $escaped = true ] )
ユーザによって検索フォームで入力された検索キーフレーズを取得する。

パラメータ

  • $escaped
    エスケープ処理を行う場合はtrue、行わない場合はfalseを指定

返り値

検索キーフレーズを返す。検索キーフレーズが未入力の場合は""を返す。

注意

返り値はstripslashes関数(PHP)によってバックスラッシュを取り除かれた文字列になる。

使用例

  • 検索キーフレーズを取得する。
    <?php $query = get_search_query( ); ?>
  • エスケープ処理を行わずに検索キーフレーズを取得する。
    <?php $query = get_search_query( false ); ?>

フィルター

'get_search_query'フィルターを呼び出す。$queryには、 get_query_var( 's' )で取得した値が格納される。
$query = apply_filters( 'get_search_query', $query );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2018年05月27日 10:50



お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。