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



お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。