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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。