• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get category

提供: WordPress Codex 日本語版
移動先: 案内検索

カテゴリー ID またはカテゴリーオブジェクトを指定して、カテゴリーの詳細データを取得します。

$category パラメータにオブジェクトを指定すると、それはデータベースから取得されたカテゴリー行オブジェクトと判断されます。その場合、カテゴリーの詳細データはキャッシュされます。

$category パラメータに整数を指定するとカテゴリー ID と判断されます。もしカテゴリーがキャッシュされていなかった場合、カテゴリーはデータベースから取得されて、戻り値として返されます。

get_term() を見ると、どちらの場合もいくつかのフィルターを通された後、最終的にパラメータ $filter で指定されたフィルターによって無害化(サニタイズ)されることがわかります。

カテゴリーの詳細データは後方互換性を保つため変換されます。

注意:ID からリンクカテゴリーを取得するには get_term() を使用してください。get_category()は、投稿カテゴリーしか返しません。

使い方

<?php get_category( $category, $output, $filter ) ?>

パラメータ

$category
整数|オブジェクト) (必須) カテゴリー ID またはカテゴリー行オブジェクト
初期値: なし
$output
文字列) (オプション) 定数 OBJECT, ARRAY_A または ARRAY_N
初期値: OBJECT
$filter
文字列) (オプション) デフォルト('raw')では WordPress が予め定義したフィルターはどれも適用されません。
初期値: 'raw'

戻り値

(mixed) 
$output パラメータで指定された型で、カテゴリー詳細データを返します。

用例

$thisCat = get_category( get_query_var( 'cat' ), false );
print_r( $thisCat );

上のコードにより、例えば下記のように表示されます。

stdClass Object
(
    [term_id] => 85
    [name] => Category Name
    [slug] => category-name
    [term_group] => 0
    [term_taxonomy_id] => 85
    [taxonomy] => category
    [description] => 
    [parent] => 70
    [count] => 0
    [cat_ID] => 85
    [category_count] => 0
    [category_description] => 
    [cat_name] => Category Name
    [category_nicename] => category-name
    [category_parent] => 70
)

参考

  • タクソノミーからカテゴリーデータを取得する際に get_term() が使われています。
  • カスタム投稿タイプが標準のカテゴリーを使っている場合、count 値はカスタム投稿タイプの投稿を含んだ数値になります。

変更履歴

  • 1.5.1 にて導入されました。

ソースファイル

get_category()wp-includes/category.php に含まれています。


カテゴリータグ: the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category() , get_term()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/get_category最新版との差分