get_search_query

(2.3.0以降)
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

関連

お勧めコンテンツ

LevelとCapability(2011年4月14日 登録)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

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

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

WP_List_Tableクラスを使ってみた(2017年8月23日 登録)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

一定時間でログアウトする(2013年5月23日 登録)

ログイン関係を調べている関係で、wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。

Login rebuilder 2.3.0の新機能を紹介(2017年8月31日 登録)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

最終更新日時 : 2013-01-19 11:43