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



お勧め

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

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

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

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

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

「Align widgets horizontally」プラグインのフィルター使用例(2024年5月15日 更新)

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。