説明
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
関連
お勧め
5.5で非推奨になる関数名について（2020年8月12日 更新）
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい（2013年11月27日 更新）
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）
query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？