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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。