get_query_var()


WordPressのget_query_var()関数は、現在のクエリから特定の変数の値を取得するために使用されます。この関数は、カスタムクエリ変数やデフォルトのクエリ変数（例えば、ページ番号やカテゴリIDなど）を取得する際に役立ちます。

構文

get_query_var( string $var, mixed $default = '' );

引数の説明:

  • $var (string) — 取得したいクエリ変数の名前。
  • $default (mixed) — クエリ変数が存在しない場合に返されるデフォルト値。

例1: 現在のページ番号を取得する

この例では、現在のページ番号を取得します。

<?php $paged = get_query_var('paged'); ?>

例2: カテゴリIDを取得する

この例では、現在のカテゴリIDを取得します。

<?php $cat_id = get_query_var('cat'); ?>

例3: タグ名を取得する

この例では、現在のタグ名を取得します。

<?php $tag = get_query_var('tag'); ?>

例4: カスタムクエリ変数を取得する

この例では、カスタムクエリ変数「my_custom_var」の値を取得します。

<?php $custom_var = get_query_var('my_custom_var'); ?>

例5: デフォルト値を指定してクエリ変数を取得する

この例では、クエリ変数が存在しない場合にデフォルト値「default_value」を返します。

<?php $custom_var = get_query_var('my_custom_var', 'default_value'); ?>

例6: 投稿スラッグを取得する

この例では、現在の投稿スラッグを取得します。

<?php $post_slug = get_query_var('name'); ?>

例7: 検索クエリを取得する

この例では、検索クエリを取得します。

<?php $search_query = get_query_var('s'); ?>

例8: カスタムタクソノミーのタームを取得する

この例では、カスタムタクソノミー「my_taxonomy」のタームを取得します。

<?php $term = get_query_var('my_taxonomy'); ?>

注意点

  • get_query_var()は、クエリ変数が存在しない場合に空の値を返すことがあります。そのため、デフォルト値を指定することが推奨されます。
  • カスタムクエリ変数を使用する場合、事前にquery_varsフィルターを使用して変数を登録する必要があります。

関連機能：