get_query_var

説明

mixed get_query_var( string $var [ , mixed $default_value = '' ] )
投稿検索に関連する変数の値を取得する。

パラメータ

  • $var
    投稿検索に関連する変数名を指定。主な変数名は次の通り。
    変数名返り値の型意味
    catstringカテゴリID
    category_namestringカテゴリ名
    category__andarrayすべてに該当するカテゴリIDの配列
    category__inarray該当するカテゴリIDの配列
    category__not_inarray除外するカテゴリIDの配列
    meta_keystringカスタムフィールドの名前
    meta_valuestringカスタムフィールドの値
    orderstring並び順
    orderbystring並び順を決める項目名
    pint投稿情報ID
    pagedintページング時のページ番号
    post__inarray該当する投稿情報IDの配列
    post__not_inarray除外する投稿情報IDの配列
    posts_par_pageint1ページの投稿数
    sstring検索キーワード
    tagstring投稿タグ名
    tag_idint投稿タグID
    tag__andarrayすべてに該当する投稿タグIDの配列
    tag__inarray該当する投稿タグIDの配列
    tag__not_inarray除外する投稿タグIDの配列
    tag_slug__andarrayすべてに該当する投稿タグスラッグの配列
    tag_slug__inarray該当する投稿タグスラッグの配列
  • $default_value
    [3.9.0]デフォルト値を指定(省略時は'')。

返り値

投稿検索に関連する変数の値を返す。パラメータ$varの名前に該当する変数がない場合は''パラメータ$default_valueの値を返す。

注意

テーマ内のfunctions.phpで使用する場合、投稿記事の検索が行われる前に実行すると検索関連の変数は設定されてないため、戻り値は必ず''パラメータ$default_valueの値となる。

独自の変数を追加する場合は、'query_vars'フィルターを使用する。

function my_query_vars( $query_vars ) {
	$query_vars[] = 'my_nonce';
	return $query_vars;
}

add_filter( 'query_vars', 'my_query_vars' );

[3.9.0]パラメータ$default_valueが追加され、任意の値をデフォルト値として指定できるようになった。


使用例

  • 'paged'の値を取得する。
    <?php $value = get_query_var( 'paged' ); ?>

フィルター

直接実行するフィルターはありません。

アクション

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

ソースファイル

/wp-includes/query.php

最終更新 : 2025年01月12日 00:50



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

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

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

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。