• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get search query

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/get search query」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

サイト内検索を行ったときのクエリ文字列を取得します。検索クエリ文字列を HTML 属性に配置する場合は、安全のため esc_attr() を適用すべきです。

この関数はクエリ文字列を表示するのではなく返します。表示するには the_search_query() が使えます。

使い方

<?php $search_query = get_search_query( $escaped ); ?>

パラメータ

$escaped
真偽値) (オプション) 結果をエスケープするかどうか。デフォルトは true です。エスケープせずに使うのは避けて、もし false を指定したときは後でエスケープしてください。
初期値: true

戻り値

(文字列) 
検索クエリ文字列。

用例

異なる使い方の例です。

<?php echo get_search_query(); ?>
<?php $search_query = get_search_query(); ?>

参考

  • get_query_var() を使って検索クエリ文字列 's' を取得します。
  • フィルター 'get_search_query' を通します。
  • $escaped が true なら esc_attr() を適用して安全な結果を返します。

変更履歴

新規導入 : 2.3.0

ソースファイル

get_search_query()wp-includes/general-template.php にあります。


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Template Tags/get_search_query最新版との差分